API EXPLORER
Version 3.0
Allocation v3.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Allocations divide the responsibility for an expense. Allocation entries consist of a percentage of the original expense, and the configured custom fields. Allocation entries are children of the expense entry. This API provides methods to view all allocations for a user or report, or view an allocation by ID.
Base URLs:
Resources
get__expense_allocations
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/expense/allocations \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://www.concursolutions.com/api/v3.0/expense/allocations HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/allocations',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/expense/allocations',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/expense/allocations', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/expense/allocations', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/allocations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/expense/allocations", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /expense/allocations
Get allocations
Gets all allocations per entry or report.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| limit | query | integer(int32) | false | The number of records to return. The default is 25 and the maximum is 100. |
| offset | query | string | false | The starting point of the next set of results, after the limit specified in the limit field has been reached. |
| reportID | query | string | false | The unique identifier for the report as it appears in Concur Expense. Format: A variable-length string. Maximum length: 32 characters. |
| entryID | query | string | false | The unique identifier for the expense entry. |
| itemizationID | query | string | false | The unique identifier for the expense itemization. |
| user | query | string | false | The login ID of the user who owns the allocation. The user must have the Web Services Admin role to use this parameter. |
Example responses
200 Response
{
"Items": {
"AccountCode1": "string",
"AccountCode2": "string",
"Custom1": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom2": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom3": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom4": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom5": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom6": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom7": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom8": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom9": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom10": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom11": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom12": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom13": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom14": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom15": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom16": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom17": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom18": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom19": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom20": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"EntryID": "string",
"ID": "string",
"IsHidden": true,
"IsPercentEdited": true,
"Percentage": "string",
"URI": "string"
},
"NextPage": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<AllocationCollection>
<Items>
<AccountCode1>string</AccountCode1>
<AccountCode2>string</AccountCode2>
<Custom1>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom1>
<Custom2>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom2>
<Custom3>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom3>
<Custom4>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom4>
<Custom5>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom5>
<Custom6>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom6>
<Custom7>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom7>
<Custom8>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom8>
<Custom9>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom9>
<Custom10>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom10>
<Custom11>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom11>
<Custom12>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom12>
<Custom13>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom13>
<Custom14>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom14>
<Custom15>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom15>
<Custom16>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom16>
<Custom17>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom17>
<Custom18>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom18>
<Custom19>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom19>
<Custom20>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom20>
<EntryID>string</EntryID>
<ID>string</ID>
<IsHidden>true</IsHidden>
<IsPercentEdited>true</IsPercentEdited>
<Percentage>string</Percentage>
<URI>string</URI>
</Items>
<NextPage>string</NextPage>
</AllocationCollection>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | AllocationCollection |
get_expense_allocations{id}
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/expense/allocations/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://www.concursolutions.com/api/v3.0/expense/allocations/{id} HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/allocations/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/expense/allocations/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/expense/allocations/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/expense/allocations/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/allocations/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/expense/allocations/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /expense/allocations/{id}
Get a single allocation
Gets the allocation for the supplied ID.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The unique identifier for the allocation. |
| user | query | string | false | The login ID of the user who owns the allocation. The user must have the Web Services Admin role to use this parameter. |
Example responses
200 Response
{
"AccountCode1": "string",
"AccountCode2": "string",
"Custom1": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom2": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom3": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom4": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom5": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom6": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom7": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom8": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom9": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom10": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom11": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom12": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom13": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom14": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom15": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom16": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom17": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom18": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom19": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom20": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"EntryID": "string",
"ID": "string",
"IsHidden": true,
"IsPercentEdited": true,
"Percentage": "string",
"URI": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<AllocationGet>
<AccountCode1>string</AccountCode1>
<AccountCode2>string</AccountCode2>
<Custom1>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom1>
<Custom2>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom2>
<Custom3>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom3>
<Custom4>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom4>
<Custom5>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom5>
<Custom6>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom6>
<Custom7>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom7>
<Custom8>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom8>
<Custom9>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom9>
<Custom10>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom10>
<Custom11>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom11>
<Custom12>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom12>
<Custom13>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom13>
<Custom14>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom14>
<Custom15>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom15>
<Custom16>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom16>
<Custom17>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom17>
<Custom18>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom18>
<Custom19>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom19>
<Custom20>
<Code>string</Code>
<Label>string</Label>
<ListItemID>string</ListItemID>
<Sequence>0</Sequence>
<Type>string</Type>
<Value>string</Value>
</Custom20>
<EntryID>string</EntryID>
<ID>string</ID>
<IsHidden>true</IsHidden>
<IsPercentEdited>true</IsPercentEdited>
<Percentage>string</Percentage>
<URI>string</URI>
</AllocationGet>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | AllocationGet |
Schemas
AllocationCollection
{
"Items": {
"AccountCode1": "string",
"AccountCode2": "string",
"Custom1": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom2": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom3": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom4": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom5": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom6": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom7": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom8": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom9": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom10": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom11": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom12": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom13": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom14": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom15": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom16": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom17": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom18": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom19": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom20": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"EntryID": "string",
"ID": "string",
"IsHidden": true,
"IsPercentEdited": true,
"Percentage": "string",
"URI": "string"
},
"NextPage": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Items | AllocationGet | false | none | none |
| NextPage | string | false | none | The URI of the next page of results, if any. |
AllocationGet
{
"AccountCode1": "string",
"AccountCode2": "string",
"Custom1": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom2": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom3": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom4": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom5": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom6": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom7": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom8": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom9": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom10": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom11": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom12": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom13": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom14": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom15": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom16": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom17": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom18": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom19": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"Custom20": {
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
},
"EntryID": "string",
"ID": "string",
"IsHidden": true,
"IsPercentEdited": true,
"Percentage": "string",
"URI": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| AccountCode1 | string | false | none | The primary accounting code assigned to the expense type associated with this allocation. Typically, expense types have only a primary account code. |
| AccountCode2 | string | false | none | The secondary or alternative accounting code assigned to the expense type associated with this allocation. |
| Custom1 | CustomFieldExtension | false | none | none |
| Custom2 | CustomFieldExtension | false | none | none |
| Custom3 | CustomFieldExtension | false | none | none |
| Custom4 | CustomFieldExtension | false | none | none |
| Custom5 | CustomFieldExtension | false | none | none |
| Custom6 | CustomFieldExtension | false | none | none |
| Custom7 | CustomFieldExtension | false | none | none |
| Custom8 | CustomFieldExtension | false | none | none |
| Custom9 | CustomFieldExtension | false | none | none |
| Custom10 | CustomFieldExtension | false | none | none |
| Custom11 | CustomFieldExtension | false | none | none |
| Custom12 | CustomFieldExtension | false | none | none |
| Custom13 | CustomFieldExtension | false | none | none |
| Custom14 | CustomFieldExtension | false | none | none |
| Custom15 | CustomFieldExtension | false | none | none |
| Custom16 | CustomFieldExtension | false | none | none |
| Custom17 | CustomFieldExtension | false | none | none |
| Custom18 | CustomFieldExtension | false | none | none |
| Custom19 | CustomFieldExtension | false | none | none |
| Custom20 | CustomFieldExtension | false | none | none |
| EntryID | string | false | none | The unique identifier for the expense entry. |
| ID | string | false | none | The unique identifier of the resource. |
| IsHidden | boolean | false | none | Indicates whether the allocation is hidden. Format: true or false |
| IsPercentEdited | boolean | false | none | Indicates whether the allocation percentage has been edited. Format: true or false |
| Percentage | string | false | none | The percentage of the expense that is included in this allocation. |
| URI | string | false | none | The URI to the resource. |
CustomFieldExtension
{
"Code": "string",
"Label": "string",
"ListItemID": "string",
"Sequence": 0,
"Type": "string",
"Value": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Code | string | false | none | For list fields, this is the list item code. |
| Label | string | false | none | The label value for the custom field. |
| ListItemID | string | false | none | For list fields, this is the list item ID. |
| Sequence | integer(int32) | false | none | The order in which this field appears on the form. |
| Type | string | false | none | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text |
| Value | string | false | none | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters |
Attendee Types v3.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Get the configured attendee types for the company or for a specified user. You can also update attendee types by providing some or all of the attendee type fields.
Base URLs:
Resources
get__expense_attendeetypes
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/expense/attendeetypes \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://www.concursolutions.com/api/v3.0/expense/attendeetypes HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/attendeetypes',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/expense/attendeetypes',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/expense/attendeetypes', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/expense/attendeetypes', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/attendeetypes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/expense/attendeetypes", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /expense/attendeetypes
Get all attendee types
Gets all active attendee types for the company.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| offset | query | string | false | The starting point of the next set of results, after the limit specified in the limit field has been reached. |
| limit | query | integer(int32) | false | The number of records to return. Default value: 25 |
Example responses
200 Response
{
"Items": {
"AllowAttendeeCountEditing": true,
"AllowManuallyEnteredAttendees": true,
"AttendeeFormID": "string",
"Code": "string",
"ConnectorID": "string",
"DuplicateSearchFields": [
"string"
],
"ID": "string",
"Name": "string",
"URI": "string"
},
"NextPage": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<AttendeeTypesCollection>
<Items>
<AllowAttendeeCountEditing>true</AllowAttendeeCountEditing>
<AllowManuallyEnteredAttendees>true</AllowManuallyEnteredAttendees>
<AttendeeFormID>string</AttendeeFormID>
<Code>string</Code>
<ConnectorID>string</ConnectorID>
<DuplicateSearchFields>string</DuplicateSearchFields>
<ID>string</ID>
<Name>string</Name>
<URI>string</URI>
</Items>
<NextPage>string</NextPage>
</AttendeeTypesCollection>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | AttendeeTypesCollection |
post__expense_attendeetypes
Code samples
# You can also use wget
curl -X POST https://www.concursolutions.com/api/v3.0/expense/attendeetypes \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://www.concursolutions.com/api/v3.0/expense/attendeetypes HTTP/1.1
Host: www.concursolutions.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"AllowAttendeeCountEditing": true,
"AllowManuallyEnteredAttendees": true,
"AttendeeFormID": "string",
"Code": "string",
"ConnectorID": "string",
"DuplicateSearchFields": [
"string"
],
"Name": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/attendeetypes',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://www.concursolutions.com/api/v3.0/expense/attendeetypes',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://www.concursolutions.com/api/v3.0/expense/attendeetypes', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://www.concursolutions.com/api/v3.0/expense/attendeetypes', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/attendeetypes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://www.concursolutions.com/api/v3.0/expense/attendeetypes", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /expense/attendeetypes
Create a new attendee type
DEPRECATED: 05/19/2016 UNSUPPORTED: 11/19/2016 Creates a new attendee type.
Body parameter
{
"AllowAttendeeCountEditing": true,
"AllowManuallyEnteredAttendees": true,
"AttendeeFormID": "string",
"Code": "string",
"ConnectorID": "string",
"DuplicateSearchFields": [
"string"
],
"Name": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<AttendeeTypePost>
<AllowAttendeeCountEditing>true</AllowAttendeeCountEditing>
<AllowManuallyEnteredAttendees>true</AllowManuallyEnteredAttendees>
<AttendeeFormID>string</AttendeeFormID>
<Code>string</Code>
<ConnectorID>string</ConnectorID>
<DuplicateSearchFields>string</DuplicateSearchFields>
<Name>string</Name>
</AttendeeTypePost>
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | AttendeeTypePost | true | The AttendeeType object to create. |
Example responses
200 Response
{
"ID": "string",
"URI": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CreateResponse>
<ID>string</ID>
<URI>string</URI>
</CreateResponse>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | CreateResponse |
| 400 | Bad Request | Bad Request | Void |
get_expense_attendeetypes{id}
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/expense/attendeetypes/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://www.concursolutions.com/api/v3.0/expense/attendeetypes/{id} HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/attendeetypes/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/expense/attendeetypes/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/expense/attendeetypes/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/expense/attendeetypes/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/attendeetypes/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/expense/attendeetypes/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /expense/attendeetypes/{id}
Get a single attendee type
Gets an attendee type for the specified ID.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The ID of the attendee type. |
Example responses
200 Response
{
"AllowAttendeeCountEditing": true,
"AllowManuallyEnteredAttendees": true,
"AttendeeFormID": "string",
"Code": "string",
"ConnectorID": "string",
"DuplicateSearchFields": [
"string"
],
"ID": "string",
"Name": "string",
"URI": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<AttendeeTypeGet>
<AllowAttendeeCountEditing>true</AllowAttendeeCountEditing>
<AllowManuallyEnteredAttendees>true</AllowManuallyEnteredAttendees>
<AttendeeFormID>string</AttendeeFormID>
<Code>string</Code>
<ConnectorID>string</ConnectorID>
<DuplicateSearchFields>string</DuplicateSearchFields>
<ID>string</ID>
<Name>string</Name>
<URI>string</URI>
</AttendeeTypeGet>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | AttendeeTypeGet |
delete_expense_attendeetypes{id}
Code samples
# You can also use wget
curl -X DELETE https://www.concursolutions.com/api/v3.0/expense/attendeetypes/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
DELETE https://www.concursolutions.com/api/v3.0/expense/attendeetypes/{id} HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/attendeetypes/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://www.concursolutions.com/api/v3.0/expense/attendeetypes/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://www.concursolutions.com/api/v3.0/expense/attendeetypes/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','https://www.concursolutions.com/api/v3.0/expense/attendeetypes/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/attendeetypes/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://www.concursolutions.com/api/v3.0/expense/attendeetypes/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /expense/attendeetypes/{id}
Delete an attendee type by ID
DEPRECATED: 05/19/2016 UNSUPPORTED: 11/19/2016 Deletes the specified attendee type.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The ID of the attendee type to delete. |
Example responses
200 Response
{}
<?xml version="1.0" encoding="UTF-8" ?>
<Void/>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Void |
| 400 | Bad Request | Bad Request | Void |
put_expense_attendeetypes{id}
Code samples
# You can also use wget
curl -X PUT https://www.concursolutions.com/api/v3.0/expense/attendeetypes/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
PUT https://www.concursolutions.com/api/v3.0/expense/attendeetypes/{id} HTTP/1.1
Host: www.concursolutions.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"AllowAttendeeCountEditing": true,
"AllowManuallyEnteredAttendees": true,
"AttendeeFormID": "string",
"Code": "string",
"ConnectorID": "string",
"DuplicateSearchFields": [
"string"
],
"Name": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/attendeetypes/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put 'https://www.concursolutions.com/api/v3.0/expense/attendeetypes/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('https://www.concursolutions.com/api/v3.0/expense/attendeetypes/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','https://www.concursolutions.com/api/v3.0/expense/attendeetypes/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/attendeetypes/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://www.concursolutions.com/api/v3.0/expense/attendeetypes/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /expense/attendeetypes/{id}
Update an attendee type by ID
Updates the specified attendee type. Only the fields provided in the supplied object will be updated. Missing fields will not be altered.
Body parameter
{
"AllowAttendeeCountEditing": true,
"AllowManuallyEnteredAttendees": true,
"AttendeeFormID": "string",
"Code": "string",
"ConnectorID": "string",
"DuplicateSearchFields": [
"string"
],
"Name": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<AttendeeTypePut>
<AllowAttendeeCountEditing>true</AllowAttendeeCountEditing>
<AllowManuallyEnteredAttendees>true</AllowManuallyEnteredAttendees>
<AttendeeFormID>string</AttendeeFormID>
<Code>string</Code>
<ConnectorID>string</ConnectorID>
<DuplicateSearchFields>string</DuplicateSearchFields>
<Name>string</Name>
</AttendeeTypePut>
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The ID of the attendee type. |
| body | body | AttendeeTypePut | true | The partial or complete AttendeeType object to update. |
Example responses
200 Response
{}
<?xml version="1.0" encoding="UTF-8" ?>
<Void/>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Void |
| 400 | Bad Request | Bad Request | Void |
Schemas
AttendeeTypeGet
{
"AllowAttendeeCountEditing": true,
"AllowManuallyEnteredAttendees": true,
"AttendeeFormID": "string",
"Code": "string",
"ConnectorID": "string",
"DuplicateSearchFields": [
"string"
],
"ID": "string",
"Name": "string",
"URI": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| AllowAttendeeCountEditing | boolean | false | none | Determines whether users are allowed to edit the count for this attendee type. Format: true or false |
| AllowManuallyEnteredAttendees | boolean | false | none | Determines whether users are allowed to add attendees for this attendee type. Format: true or false |
| AttendeeFormID | string | false | none | The unique identifier for the attendee form for this attendee type. |
| Code | string | false | none | A code that indicates the type of attendee. Examples: EMPLOYEE, SPOUSE, BUSGUEST. Maximum length: 40 characters |
| ConnectorID | string | false | none | The unique identifier for the Application Connector that is the data source for this attendee type. When this field is empty, Concur Expense is the data source. |
| DuplicateSearchFields | [string] | false | none | The list of Attendee field IDs used by the Add Attendee user interface to alert users that the attendee they want to add is a possible duplicate. |
| ID | string | false | none | The unique identifier of the resource. |
| Name | string | false | none | The name for the attendee type. This name must be unique. Maximum length: 40 characters |
| URI | string | false | none | The URI to the resource. |
AttendeeTypePost
{
"AllowAttendeeCountEditing": true,
"AllowManuallyEnteredAttendees": true,
"AttendeeFormID": "string",
"Code": "string",
"ConnectorID": "string",
"DuplicateSearchFields": [
"string"
],
"Name": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| AllowAttendeeCountEditing | boolean | false | none | Determines whether users are allowed to edit the count for this attendee type. Format: true or false |
| AllowManuallyEnteredAttendees | boolean | false | none | Determines whether users are allowed to add attendees for this attendee type. Format: true or false |
| AttendeeFormID | string | false | none | The unique identifier for the attendee form for this attendee type. |
| Code | string | false | none | A code that indicates the type of attendee. Examples: EMPLOYEE, SPOUSE, BUSGUEST. Maximum length: 40 characters |
| ConnectorID | string | false | none | The unique identifier for the Application Connector that is the data source for this attendee type. When this field is empty, Concur Expense is the data source. |
| DuplicateSearchFields | [string] | false | none | The list of Attendee field IDs used by the Add Attendee user interface to alert users that the attendee they want to add is a possible duplicate. |
| Name | string | false | none | The name for the attendee type. This name must be unique. Maximum length: 40 characters |
AttendeeTypePut
{
"AllowAttendeeCountEditing": true,
"AllowManuallyEnteredAttendees": true,
"AttendeeFormID": "string",
"Code": "string",
"ConnectorID": "string",
"DuplicateSearchFields": [
"string"
],
"Name": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| AllowAttendeeCountEditing | boolean | false | none | Determines whether users are allowed to edit the count for this attendee type. Format: true or false |
| AllowManuallyEnteredAttendees | boolean | false | none | Determines whether users are allowed to add attendees for this attendee type. Format: true or false |
| AttendeeFormID | string | false | none | The unique identifier for the attendee form for this attendee type. |
| Code | string | false | none | A code that indicates the type of attendee. Examples: EMPLOYEE, SPOUSE, BUSGUEST. Maximum length: 40 characters |
| ConnectorID | string | false | none | The unique identifier for the Application Connector that is the data source for this attendee type. When this field is empty, Concur Expense is the data source. |
| DuplicateSearchFields | [string] | false | none | The list of Attendee field IDs used by the Add Attendee user interface to alert users that the attendee they want to add is a possible duplicate. |
| Name | string | false | none | The name for the attendee type. This name must be unique. Maximum length: 40 characters |
AttendeeTypesCollection
{
"Items": {
"AllowAttendeeCountEditing": true,
"AllowManuallyEnteredAttendees": true,
"AttendeeFormID": "string",
"Code": "string",
"ConnectorID": "string",
"DuplicateSearchFields": [
"string"
],
"ID": "string",
"Name": "string",
"URI": "string"
},
"NextPage": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Items | AttendeeTypeGet | false | none | none |
| NextPage | string | false | none | The URI of the next page of results, if any. |
CreateResponse
{
"ID": "string",
"URI": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ID | string | false | none | The URI of the next page of results, if any. |
| URI | string | false | none | The URI of the next page of results, if any. |
Void
{}
Properties
None
Attendees v3.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Get the configured attendees for a user. You can also update attendees by providing some or all of the attendee fields, or create new attendees.
Base URLs:
Resources
get__expense_attendees
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/expense/attendees \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://www.concursolutions.com/api/v3.0/expense/attendees HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/attendees',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/expense/attendees',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/expense/attendees', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/expense/attendees', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/attendees");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/expense/attendees", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /expense/attendees
Get all attendees
Gets all attendees owned by the specified user, or the user associated with the access token.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| externalID | query | string | false | The external ID of an attendee. By entering a value for this parameter, you can limit the results to the attendees who match the specified external ID. Up to 10 comma-separated external IDs may be specified. |
| attendeeTypeID | query | string | false | The ID of an attendee type. By entering a value for this parameter, you can limit the results to the attendees who match the specified type. |
| offset | query | string | false | The starting point of the next set of results, after the limit specified in the limit field has been reached. |
| limit | query | integer(int32) | false | The number of records to return. Default value: 25 |
| user | query | string | false | The login ID of the user that has added the attendee to an expense. The user who is performing this API request must have the Web Services Admin (Professional) or Can Administer (Standard) user role to use this parameter. |
Example responses
200 Response
{
"Items": {
"AttendeeTypeCode": "string",
"AttendeeTypeID": "string",
"Company": "string",
"CurrencyCode": "string",
"Custom1": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom2": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom3": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom4": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom5": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom6": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom7": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom8": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom9": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom10": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom11": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom12": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom13": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom14": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom15": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom16": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom17": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom18": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom19": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom20": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom21": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom22": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom23": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom24": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom25": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"ExternalID": "string",
"FirstName": "string",
"HasExceptionsPrevYear": true,
"HasExceptionsYTD": true,
"ID": "string",
"LastName": "string",
"MiddleInitial": "string",
"OwnerLoginID": "string",
"OwnerName": "string",
"Suffix": "string",
"Title": "string",
"TotalAmountPrevYear": 0,
"TotalAmountYTD": 0,
"URI": "string",
"VersionNumber": 0
},
"NextPage": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<AttendeeCollection>
<Items>
<AttendeeTypeCode>string</AttendeeTypeCode>
<AttendeeTypeID>string</AttendeeTypeID>
<Company>string</Company>
<CurrencyCode>string</CurrencyCode>
<Custom1>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom1>
<Custom2>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom2>
<Custom3>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom3>
<Custom4>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom4>
<Custom5>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom5>
<Custom6>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom6>
<Custom7>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom7>
<Custom8>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom8>
<Custom9>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom9>
<Custom10>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom10>
<Custom11>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom11>
<Custom12>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom12>
<Custom13>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom13>
<Custom14>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom14>
<Custom15>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom15>
<Custom16>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom16>
<Custom17>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom17>
<Custom18>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom18>
<Custom19>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom19>
<Custom20>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom20>
<Custom21>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom21>
<Custom22>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom22>
<Custom23>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom23>
<Custom24>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom24>
<Custom25>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom25>
<ExternalID>string</ExternalID>
<FirstName>string</FirstName>
<HasExceptionsPrevYear>true</HasExceptionsPrevYear>
<HasExceptionsYTD>true</HasExceptionsYTD>
<ID>string</ID>
<LastName>string</LastName>
<MiddleInitial>string</MiddleInitial>
<OwnerLoginID>string</OwnerLoginID>
<OwnerName>string</OwnerName>
<Suffix>string</Suffix>
<Title>string</Title>
<TotalAmountPrevYear>0</TotalAmountPrevYear>
<TotalAmountYTD>0</TotalAmountYTD>
<URI>string</URI>
<VersionNumber>0</VersionNumber>
</Items>
<NextPage>string</NextPage>
</AttendeeCollection>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | AttendeeCollection |
post__expense_attendees
Code samples
# You can also use wget
curl -X POST https://www.concursolutions.com/api/v3.0/expense/attendees \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://www.concursolutions.com/api/v3.0/expense/attendees HTTP/1.1
Host: www.concursolutions.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"AttendeeTypeID": "string",
"Company": "string",
"CurrencyCode": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom21": "string",
"Custom22": "string",
"Custom23": "string",
"Custom24": "string",
"Custom25": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"ExternalID": "string",
"FirstName": "string",
"LastName": "string",
"MiddleInitial": "string",
"Suffix": "string",
"Title": "string",
"TotalAmountYTD": 0
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/attendees',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://www.concursolutions.com/api/v3.0/expense/attendees',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://www.concursolutions.com/api/v3.0/expense/attendees', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://www.concursolutions.com/api/v3.0/expense/attendees', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/attendees");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://www.concursolutions.com/api/v3.0/expense/attendees", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /expense/attendees
Create attendee
Creates a new attendee.
Body parameter
{
"AttendeeTypeID": "string",
"Company": "string",
"CurrencyCode": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom21": "string",
"Custom22": "string",
"Custom23": "string",
"Custom24": "string",
"Custom25": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"ExternalID": "string",
"FirstName": "string",
"LastName": "string",
"MiddleInitial": "string",
"Suffix": "string",
"Title": "string",
"TotalAmountYTD": 0
}
<?xml version="1.0" encoding="UTF-8" ?>
<AttendeePost>
<AttendeeTypeID>string</AttendeeTypeID>
<Company>string</Company>
<CurrencyCode>string</CurrencyCode>
<Custom1>string</Custom1>
<Custom10>string</Custom10>
<Custom11>string</Custom11>
<Custom12>string</Custom12>
<Custom13>string</Custom13>
<Custom14>string</Custom14>
<Custom15>string</Custom15>
<Custom16>string</Custom16>
<Custom17>string</Custom17>
<Custom18>string</Custom18>
<Custom19>string</Custom19>
<Custom2>string</Custom2>
<Custom20>string</Custom20>
<Custom21>string</Custom21>
<Custom22>string</Custom22>
<Custom23>string</Custom23>
<Custom24>string</Custom24>
<Custom25>string</Custom25>
<Custom3>string</Custom3>
<Custom4>string</Custom4>
<Custom5>string</Custom5>
<Custom6>string</Custom6>
<Custom7>string</Custom7>
<Custom8>string</Custom8>
<Custom9>string</Custom9>
<ExternalID>string</ExternalID>
<FirstName>string</FirstName>
<LastName>string</LastName>
<MiddleInitial>string</MiddleInitial>
<Suffix>string</Suffix>
<Title>string</Title>
<TotalAmountYTD>0</TotalAmountYTD>
</AttendeePost>
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| user | query | string | false | The login ID of the user that has added the attendee to an expense. The user who is performing this API request must have the Web Services Admin (Professional) or Can Administer (Standard) user role to use this parameter. |
| body | body | AttendeePost | true | The Attendee object to create. |
Example responses
200 Response
{
"ID": "string",
"URI": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CreateResponse>
<ID>string</ID>
<URI>string</URI>
</CreateResponse>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | CreateResponse |
| 400 | Bad Request | Bad Request | Void |
get_expense_attendees{id}
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/expense/attendees/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://www.concursolutions.com/api/v3.0/expense/attendees/{id} HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/attendees/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/expense/attendees/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/expense/attendees/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/expense/attendees/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/attendees/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/expense/attendees/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /expense/attendees/{id}
Get attendee
Gets a single attendee by ID.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The attendee ID. |
| user | query | string | false | The login ID of the user that has added the attendee to an expense. The user who is performing this API request must have the Web Services Admin (Professional) or Can Administer (Standard) user role to use this parameter. |
Example responses
200 Response
{
"AttendeeTypeCode": "string",
"AttendeeTypeID": "string",
"Company": "string",
"CurrencyCode": "string",
"Custom1": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom2": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom3": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom4": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom5": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom6": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom7": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom8": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom9": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom10": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom11": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom12": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom13": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom14": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom15": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom16": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom17": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom18": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom19": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom20": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom21": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom22": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom23": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom24": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom25": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"ExternalID": "string",
"FirstName": "string",
"HasExceptionsPrevYear": true,
"HasExceptionsYTD": true,
"ID": "string",
"LastName": "string",
"MiddleInitial": "string",
"OwnerLoginID": "string",
"OwnerName": "string",
"Suffix": "string",
"Title": "string",
"TotalAmountPrevYear": 0,
"TotalAmountYTD": 0,
"URI": "string",
"VersionNumber": 0
}
<?xml version="1.0" encoding="UTF-8" ?>
<AttendeeGet>
<AttendeeTypeCode>string</AttendeeTypeCode>
<AttendeeTypeID>string</AttendeeTypeID>
<Company>string</Company>
<CurrencyCode>string</CurrencyCode>
<Custom1>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom1>
<Custom2>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom2>
<Custom3>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom3>
<Custom4>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom4>
<Custom5>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom5>
<Custom6>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom6>
<Custom7>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom7>
<Custom8>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom8>
<Custom9>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom9>
<Custom10>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom10>
<Custom11>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom11>
<Custom12>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom12>
<Custom13>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom13>
<Custom14>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom14>
<Custom15>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom15>
<Custom16>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom16>
<Custom17>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom17>
<Custom18>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom18>
<Custom19>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom19>
<Custom20>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom20>
<Custom21>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom21>
<Custom22>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom22>
<Custom23>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom23>
<Custom24>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom24>
<Custom25>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom25>
<ExternalID>string</ExternalID>
<FirstName>string</FirstName>
<HasExceptionsPrevYear>true</HasExceptionsPrevYear>
<HasExceptionsYTD>true</HasExceptionsYTD>
<ID>string</ID>
<LastName>string</LastName>
<MiddleInitial>string</MiddleInitial>
<OwnerLoginID>string</OwnerLoginID>
<OwnerName>string</OwnerName>
<Suffix>string</Suffix>
<Title>string</Title>
<TotalAmountPrevYear>0</TotalAmountPrevYear>
<TotalAmountYTD>0</TotalAmountYTD>
<URI>string</URI>
<VersionNumber>0</VersionNumber>
</AttendeeGet>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | AttendeeGet |
put_expense_attendees{id}
Code samples
# You can also use wget
curl -X PUT https://www.concursolutions.com/api/v3.0/expense/attendees/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
PUT https://www.concursolutions.com/api/v3.0/expense/attendees/{id} HTTP/1.1
Host: www.concursolutions.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"AttendeeTypeID": "string",
"Company": "string",
"CurrencyCode": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom21": "string",
"Custom22": "string",
"Custom23": "string",
"Custom24": "string",
"Custom25": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"ExternalID": "string",
"FirstName": "string",
"LastName": "string",
"MiddleInitial": "string",
"Suffix": "string",
"Title": "string",
"TotalAmountYTD": 0
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/attendees/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put 'https://www.concursolutions.com/api/v3.0/expense/attendees/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('https://www.concursolutions.com/api/v3.0/expense/attendees/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','https://www.concursolutions.com/api/v3.0/expense/attendees/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/attendees/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://www.concursolutions.com/api/v3.0/expense/attendees/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /expense/attendees/{id}
Update attendee
Updates the specified attendee. Only the fields provided in the supplied object are updated. Missing fields are not altered.
Body parameter
{
"AttendeeTypeID": "string",
"Company": "string",
"CurrencyCode": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom21": "string",
"Custom22": "string",
"Custom23": "string",
"Custom24": "string",
"Custom25": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"ExternalID": "string",
"FirstName": "string",
"LastName": "string",
"MiddleInitial": "string",
"Suffix": "string",
"Title": "string",
"TotalAmountYTD": 0
}
<?xml version="1.0" encoding="UTF-8" ?>
<AttendeePut>
<AttendeeTypeID>string</AttendeeTypeID>
<Company>string</Company>
<CurrencyCode>string</CurrencyCode>
<Custom1>string</Custom1>
<Custom10>string</Custom10>
<Custom11>string</Custom11>
<Custom12>string</Custom12>
<Custom13>string</Custom13>
<Custom14>string</Custom14>
<Custom15>string</Custom15>
<Custom16>string</Custom16>
<Custom17>string</Custom17>
<Custom18>string</Custom18>
<Custom19>string</Custom19>
<Custom2>string</Custom2>
<Custom20>string</Custom20>
<Custom21>string</Custom21>
<Custom22>string</Custom22>
<Custom23>string</Custom23>
<Custom24>string</Custom24>
<Custom25>string</Custom25>
<Custom3>string</Custom3>
<Custom4>string</Custom4>
<Custom5>string</Custom5>
<Custom6>string</Custom6>
<Custom7>string</Custom7>
<Custom8>string</Custom8>
<Custom9>string</Custom9>
<ExternalID>string</ExternalID>
<FirstName>string</FirstName>
<LastName>string</LastName>
<MiddleInitial>string</MiddleInitial>
<Suffix>string</Suffix>
<Title>string</Title>
<TotalAmountYTD>0</TotalAmountYTD>
</AttendeePut>
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The attendee ID. |
| user | query | string | false | The login ID of the user that has added the attendee to an expense. The user who is performing this API request must have the Web Services Admin (Professional) or Can Administer (Standard) user role to use this parameter. |
| body | body | AttendeePut | true | The partial or complete Attendee object to update. |
Example responses
200 Response
{}
<?xml version="1.0" encoding="UTF-8" ?>
<Void/>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Void |
| 400 | Bad Request | Bad Request | Void |
delete_expense_attendees{id}
Code samples
# You can also use wget
curl -X DELETE https://www.concursolutions.com/api/v3.0/expense/attendees/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
DELETE https://www.concursolutions.com/api/v3.0/expense/attendees/{id} HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/attendees/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://www.concursolutions.com/api/v3.0/expense/attendees/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://www.concursolutions.com/api/v3.0/expense/attendees/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','https://www.concursolutions.com/api/v3.0/expense/attendees/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/attendees/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://www.concursolutions.com/api/v3.0/expense/attendees/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /expense/attendees/{id}
Delete an attendee by ID
DEPRECATED: 05/19/2016 UNSUPPORTED: 11/19/2016 Deletes the specified attendee.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The ID of the attendee to delete. |
| user | query | string | false | The login ID of the user that has added the attendee to an expense. The user who is performing this API request must have the Web Services Admin (Professional) or Can Administer (Standard) user role to use this parameter. |
Example responses
200 Response
{}
<?xml version="1.0" encoding="UTF-8" ?>
<Void/>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Void |
| 400 | Bad Request | Bad Request | Void |
Schemas
AttendeeCollection
{
"Items": {
"AttendeeTypeCode": "string",
"AttendeeTypeID": "string",
"Company": "string",
"CurrencyCode": "string",
"Custom1": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom2": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom3": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom4": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom5": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom6": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom7": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom8": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom9": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom10": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom11": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom12": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom13": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom14": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom15": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom16": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom17": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom18": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom19": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom20": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom21": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom22": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom23": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom24": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom25": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"ExternalID": "string",
"FirstName": "string",
"HasExceptionsPrevYear": true,
"HasExceptionsYTD": true,
"ID": "string",
"LastName": "string",
"MiddleInitial": "string",
"OwnerLoginID": "string",
"OwnerName": "string",
"Suffix": "string",
"Title": "string",
"TotalAmountPrevYear": 0,
"TotalAmountYTD": 0,
"URI": "string",
"VersionNumber": 0
},
"NextPage": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Items | AttendeeGet | false | none | none |
| NextPage | string | false | none | The URI of the next page of results, if any. |
AttendeeGet
{
"AttendeeTypeCode": "string",
"AttendeeTypeID": "string",
"Company": "string",
"CurrencyCode": "string",
"Custom1": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom2": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom3": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom4": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom5": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom6": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom7": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom8": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom9": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom10": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom11": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom12": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom13": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom14": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom15": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom16": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom17": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom18": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom19": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom20": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom21": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom22": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom23": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom24": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom25": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"ExternalID": "string",
"FirstName": "string",
"HasExceptionsPrevYear": true,
"HasExceptionsYTD": true,
"ID": "string",
"LastName": "string",
"MiddleInitial": "string",
"OwnerLoginID": "string",
"OwnerName": "string",
"Suffix": "string",
"Title": "string",
"TotalAmountPrevYear": 0,
"TotalAmountYTD": 0,
"URI": "string",
"VersionNumber": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| AttendeeTypeCode | string | false | none | A code that indicates the type of attendee. Examples: EMPLOYEE, SPOUSE, BUSGUEST. Maximum length: 40 characters |
| AttendeeTypeID | string | false | none | The ID of the attendee type. To obtain the attendee type ID value, use the "GET /expense/attendeetypes" endpoint. The value of the ID element in the response is the attendee type ID. |
| Company | string | false | none | The name of the attendee's company. Maximum length: 150 characters |
| CurrencyCode | string | false | none | The 3-letter ISO 4217 currency code for monetary amounts related to an attendee. |
| Custom1 | CustomField | false | none | none |
| Custom2 | CustomField | false | none | none |
| Custom3 | CustomField | false | none | none |
| Custom4 | CustomField | false | none | none |
| Custom5 | CustomField | false | none | none |
| Custom6 | CustomField | false | none | none |
| Custom7 | CustomField | false | none | none |
| Custom8 | CustomField | false | none | none |
| Custom9 | CustomField | false | none | none |
| Custom10 | CustomField | false | none | none |
| Custom11 | CustomField | false | none | none |
| Custom12 | CustomField | false | none | none |
| Custom13 | CustomField | false | none | none |
| Custom14 | CustomField | false | none | none |
| Custom15 | CustomField | false | none | none |
| Custom16 | CustomField | false | none | none |
| Custom17 | CustomField | false | none | none |
| Custom18 | CustomField | false | none | none |
| Custom19 | CustomField | false | none | none |
| Custom20 | CustomField | false | none | none |
| Custom21 | CustomField | false | none | none |
| Custom22 | CustomField | false | none | none |
| Custom23 | CustomField | false | none | none |
| Custom24 | CustomField | false | none | none |
| Custom25 | CustomField | false | none | none |
| ExternalID | string | false | none | A unique identifier for the attendee, assigned outside of Concur. Maximum length: 48 characters |
| FirstName | string | false | none | The attendee's first name. Maximum length: 50 characters |
| HasExceptionsPrevYear | boolean | false | none | Determines whether the attendee had exceptions in the previous year, based on yearly total limits for attendees. Format: true or false |
| HasExceptionsYTD | boolean | false | none | Determines whether the attendee has exceptions in the current year, based on yearly total limits for attendees. Format: true or false |
| ID | string | false | none | The unique identifier of the resource. |
| LastName | string | false | none | The attendee's last name. Maximum length: 132 characters |
| MiddleInitial | string | false | none | The attendee's middle initial. Maximum length: 1 character |
| OwnerLoginID | string | false | none | The login ID of the user who owns the attendee record. |
| OwnerName | string | false | none | The name of the user who owns the attendee record. |
| Suffix | string | false | none | The attendee's name suffix. Maximum length: 32 characters |
| Title | string | false | none | The attendee's title. Maximum length: 32 characters |
| TotalAmountPrevYear | number(double) | false | none | The total amount spent on the attendee in the previous calendar year. |
| TotalAmountYTD | number(double) | false | none | The total amount spent on the attendee in the current calendar year. |
| URI | string | false | none | The URI to the resource. |
| VersionNumber | integer(int32) | false | none | The attendee's version number. |
AttendeePost
{
"AttendeeTypeID": "string",
"Company": "string",
"CurrencyCode": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom21": "string",
"Custom22": "string",
"Custom23": "string",
"Custom24": "string",
"Custom25": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"ExternalID": "string",
"FirstName": "string",
"LastName": "string",
"MiddleInitial": "string",
"Suffix": "string",
"Title": "string",
"TotalAmountYTD": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| AttendeeTypeID | string | false | none | The ID of the attendee type. To obtain the attendee type ID value, use the "GET /expense/attendeetypes" endpoint. The value of the ID element in the response is the attendee type ID. |
| Company | string | false | none | The name of the attendee's company. Maximum length: 150 characters |
| CurrencyCode | string | false | none | The 3-letter ISO 4217 currency code for monetary amounts related to an attendee. |
| Custom1 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom10 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom11 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom12 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom13 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom14 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom15 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom16 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom17 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom18 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom19 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom2 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom20 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom21 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom22 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom23 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom24 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom25 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom3 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom4 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom5 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom6 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom7 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom8 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom9 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| ExternalID | string | false | none | A unique identifier for the attendee, assigned outside of SAP Concur. Maximum length: 48 characters |
| FirstName | string | false | none | The attendee's first name. Maximum length: 50 characters |
| LastName | string | false | none | The attendee's last name. Maximum length: 132 characters |
| MiddleInitial | string | false | none | The attendee's middle initial. Maximum length: 1 character |
| Suffix | string | false | none | The attendee's name suffix. Maximum length: 32 characters |
| Title | string | false | none | The attendee's title. Maximum length: 32 characters |
| TotalAmountYTD | number(double) | false | none | The total amount spent on the attendee in the current calendar year. |
AttendeePut
{
"AttendeeTypeID": "string",
"Company": "string",
"CurrencyCode": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom21": "string",
"Custom22": "string",
"Custom23": "string",
"Custom24": "string",
"Custom25": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"ExternalID": "string",
"FirstName": "string",
"LastName": "string",
"MiddleInitial": "string",
"Suffix": "string",
"Title": "string",
"TotalAmountYTD": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| AttendeeTypeID | string | false | none | The ID of the attendee type. To obtain the attendee type ID value, use the "GET /expense/attendeetypes" endpoint. The value of the ID element in the response is the attendee type ID. |
| Company | string | false | none | The name of the attendee's company. Maximum length: 150 characters |
| CurrencyCode | string | false | none | The 3-letter ISO 4217 currency code for monetary amounts related to an attendee. |
| Custom1 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom10 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom11 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom12 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom13 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom14 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom15 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom16 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom17 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom18 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom19 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom2 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom20 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom21 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom22 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom23 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom24 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom25 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom3 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom4 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom5 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom6 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom7 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom8 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| Custom9 | string | false | none | A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. |
| ExternalID | string | false | none | A unique identifier for the attendee, assigned outside of Concur. Maximum length: 48 characters |
| FirstName | string | false | none | The attendee's first name. Maximum length: 50 characters |
| LastName | string | false | none | The attendee's last name. Maximum length: 132 characters |
| MiddleInitial | string | false | none | The attendee's middle initial. Maximum length: 1 character |
| Suffix | string | false | none | The attendee's name suffix. Maximum length: 32 characters |
| Title | string | false | none | The attendee's title. Maximum length: 32 characters |
| TotalAmountYTD | number(double) | false | none | The total amount spent on the attendee in the current calendar year. |
CreateResponse
{
"ID": "string",
"URI": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ID | string | false | none | The attendee's title. Maximum length: 32 characters |
| URI | string | false | none | The attendee's title. Maximum length: 32 characters |
CustomField
{
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Code | string | false | none | For list fields, this is the list item code. |
| ListItemID | string | false | none | For list fields, this is the list item ID. |
| Type | string | false | none | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text |
| Value | string | false | none | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters |
Void
{}
Properties
None
Connection Requests v3.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Base URLs:
Resources
get__common_connectionrequests
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/common/connectionrequests \
-H 'Accept: application/json'
GET https://www.concursolutions.com/api/v3.0/common/connectionrequests HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://www.concursolutions.com/api/v3.0/common/connectionrequests',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/common/connectionrequests',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/common/connectionrequests', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/common/connectionrequests', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/common/connectionrequests");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/common/connectionrequests", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /common/connectionrequests
Get all connection requests
Gets all connection requests that match the TripLink supplier ID.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| offset | query | string | false | The starting point of the next set of results, after the limit specified in the limit field has been reached. The default is the beginning of the page. |
| limit | query | integer(int32) | false | The number of records to return. The default is 5 and the maximum is 10. |
| status | query | string | false | The status code representing the state of the connection request. The possible values are Pending, Processing, Connected, Failed, and Retry. |
Example responses
200 Response
{
"Items": {
"FirstName": "string",
"ID": "string",
"LastModified": "string",
"LastName": "string",
"LoyaltyNumber": "string",
"MiddleName": "string",
"RequestToken": "string",
"Status": "string",
"URI": "string"
},
"NextPage": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ConnectionRequestCollection>
<Items>
<FirstName>string</FirstName>
<ID>string</ID>
<LastModified>string</LastModified>
<LastName>string</LastName>
<LoyaltyNumber>string</LoyaltyNumber>
<MiddleName>string</MiddleName>
<RequestToken>string</RequestToken>
<Status>string</Status>
<URI>string</URI>
</Items>
<NextPage>string</NextPage>
</ConnectionRequestCollection>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ConnectionRequestCollection |
post__common_connectionrequests
Code samples
# You can also use wget
curl -X POST https://www.concursolutions.com/api/v3.0/common/connectionrequests?user=string \
-H 'Accept: application/json'
POST https://www.concursolutions.com/api/v3.0/common/connectionrequests?user=string HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://www.concursolutions.com/api/v3.0/common/connectionrequests?user=string',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.post 'https://www.concursolutions.com/api/v3.0/common/connectionrequests',
params: {
'user' => 'string'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.post('https://www.concursolutions.com/api/v3.0/common/connectionrequests', params={
'user': 'string'
}, headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://www.concursolutions.com/api/v3.0/common/connectionrequests', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/common/connectionrequests?user=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://www.concursolutions.com/api/v3.0/common/connectionrequests", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /common/connectionrequests
Create a connection request
Creates a connection request on behalf of the specified user.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| user | query | string | true | The login ID of the user for whom to create the connection request. The user must have the Web Services Admin role to use this parameter. |
Example responses
200 Response
{
"ID": "string",
"URI": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CreateResponse>
<ID>string</ID>
<URI>string</URI>
</CreateResponse>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | CreateResponse |
get_common_connectionrequests{id}
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/common/connectionrequests/{id} \
-H 'Accept: application/json'
GET https://www.concursolutions.com/api/v3.0/common/connectionrequests/{id} HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://www.concursolutions.com/api/v3.0/common/connectionrequests/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/common/connectionrequests/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/common/connectionrequests/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/common/connectionrequests/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/common/connectionrequests/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/common/connectionrequests/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /common/connectionrequests/{id}
Get a connection request by ID
Gets a connection request by ID.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The connection request ID. |
Example responses
200 Response
{
"FirstName": "string",
"ID": "string",
"LastModified": "string",
"LastName": "string",
"LoyaltyNumber": "string",
"MiddleName": "string",
"RequestToken": "string",
"Status": "string",
"URI": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ConnectionRequestGet>
<FirstName>string</FirstName>
<ID>string</ID>
<LastModified>string</LastModified>
<LastName>string</LastName>
<LoyaltyNumber>string</LoyaltyNumber>
<MiddleName>string</MiddleName>
<RequestToken>string</RequestToken>
<Status>string</Status>
<URI>string</URI>
</ConnectionRequestGet>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ConnectionRequestGet |
put_common_connectionrequests{id}
Code samples
# You can also use wget
curl -X PUT https://www.concursolutions.com/api/v3.0/common/connectionrequests/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
PUT https://www.concursolutions.com/api/v3.0/common/connectionrequests/{id} HTTP/1.1
Host: www.concursolutions.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"Status": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://www.concursolutions.com/api/v3.0/common/connectionrequests/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.put 'https://www.concursolutions.com/api/v3.0/common/connectionrequests/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.put('https://www.concursolutions.com/api/v3.0/common/connectionrequests/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','https://www.concursolutions.com/api/v3.0/common/connectionrequests/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/common/connectionrequests/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://www.concursolutions.com/api/v3.0/common/connectionrequests/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /common/connectionrequests/{id}
Update a connection request by ID
Updates the specified connection request. Only the fields provided in the supplied object are updated. Missing fields will not be altered.
Body parameter
{
"Status": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ConnectionRequestPut>
<Status>string</Status>
</ConnectionRequestPut>
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The connection request ID. |
| body | body | ConnectionRequestPut | true | The connection request object to update. |
Example responses
200 Response
{}
<?xml version="1.0" encoding="UTF-8" ?>
<Void/>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Void |
delete_common_connectionrequests{id}
Code samples
# You can also use wget
curl -X DELETE https://www.concursolutions.com/api/v3.0/common/connectionrequests/{id} \
-H 'Accept: application/json'
DELETE https://www.concursolutions.com/api/v3.0/common/connectionrequests/{id} HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://www.concursolutions.com/api/v3.0/common/connectionrequests/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.delete 'https://www.concursolutions.com/api/v3.0/common/connectionrequests/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.delete('https://www.concursolutions.com/api/v3.0/common/connectionrequests/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','https://www.concursolutions.com/api/v3.0/common/connectionrequests/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/common/connectionrequests/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://www.concursolutions.com/api/v3.0/common/connectionrequests/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /common/connectionrequests/{id}
Delete a connection request
Deletes a connection request by ID.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The connection request ID. |
Example responses
200 Response
{}
<?xml version="1.0" encoding="UTF-8" ?>
<Void/>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Void |
Schemas
ConnectionRequestCollection
{
"Items": {
"FirstName": "string",
"ID": "string",
"LastModified": "string",
"LastName": "string",
"LoyaltyNumber": "string",
"MiddleName": "string",
"RequestToken": "string",
"Status": "string",
"URI": "string"
},
"NextPage": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Items | ConnectionRequestGet | false | none | none |
| NextPage | string | false | none | The URI of the next page of results, if any. |
ConnectionRequestGet
{
"FirstName": "string",
"ID": "string",
"LastModified": "string",
"LastName": "string",
"LoyaltyNumber": "string",
"MiddleName": "string",
"RequestToken": "string",
"Status": "string",
"URI": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| FirstName | string | false | none | The user's first name. |
| ID | string | false | none | The unique identifier of the resource. |
| LastModified | string | false | none | The date and time when the connection request was last modified. Format: UTC |
| LastName | string | false | none | The user's last name. |
| LoyaltyNumber | string | false | none | The user's travel loyalty number. |
| MiddleName | string | false | none | The user's middle name. |
| RequestToken | string | false | none | The request token. |
| Status | string | false | none | The status code representing the state of the connection request. |
| URI | string | false | none | The URI to the resource. |
ConnectionRequestPut
{
"Status": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Status | string | false | none | The status code representing the state of the connection request. The possible values are: CRSUC - The supplier indicated that the connection was made successfully. CREU1 - The loyalty number was not found. CREU2 - The loyalty number doesn't match the name. CREU3 - Your loyalty account requires attention. CRPA1 - The request token has expired. CRPA2 - A network error occurred. CRRET - Retry connection. |
CreateResponse
{
"ID": "string",
"URI": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ID | string | false | none | The status code representing the state of the connection request. The possible values are: CRSUC - The supplier indicated that the connection was made successfully. CREU1 - The loyalty number was not found. CREU2 - The loyalty number doesn't match the name. CREU3 - Your loyalty account requires attention. CRPA1 - The request token has expired. CRPA2 - A network error occurred. CRRET - Retry connection. |
| URI | string | false | none | The status code representing the state of the connection request. The possible values are: CRSUC - The supplier indicated that the connection was made successfully. CREU1 - The loyalty number was not found. CREU2 - The loyalty number doesn't match the name. CREU3 - Your loyalty account requires attention. CRPA1 - The request token has expired. CRPA2 - A network error occurred. CRRET - Retry connection. |
Void
{}
Properties
None
Digital Tax Invoices v3.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
The regulations of some countries require that clients provide an electronic receipt in digital XML format for each reimbursable expense. In addition, the client must: Store the XML file in order to claim the expense for tax purposes, be able to produce the original XML file in case of audit, and validate the XML file with the government. To help meet this requirement, Concur offers the Digital Tax Invoice feature. For Mexico, the official digital XML file is called Comprobante Fiscal Digital, or CFDi. This API provides methods to view and update digital tax invoices.
Base URLs:
Resources
get__expense_digitaltaxinvoices
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/expense/digitaltaxinvoices \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://www.concursolutions.com/api/v3.0/expense/digitaltaxinvoices HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/digitaltaxinvoices',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/expense/digitaltaxinvoices',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/expense/digitaltaxinvoices', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/expense/digitaltaxinvoices', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/digitaltaxinvoices");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/expense/digitaltaxinvoices", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /expense/digitaltaxinvoices
Get digital tax invoices
Gets all digital tax invoices that can be validated by the user based on the search criteria.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| offset | query | string | false | The starting point of the next set of results, after the limit specified in the limit field has been reached. |
| limit | query | integer(int32) | false | The number of records to return. Default value: 25 |
| modifiedafter | query | string | false | A modification date for the queue record; this parameter can be used to limit the results of the GET request to the queue items that have been added since the last time the validation company queried the queue. The user must have the Web Services Admin role to use this parameter. |
Example responses
200 Response
{
"Items": {
"ConcurReceiptID": "string",
"ID": "string",
"URI": "string"
},
"NextPage": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<DigitalTaxInvoiceCollection>
<Items>
<ConcurReceiptID>string</ConcurReceiptID>
<ID>string</ID>
<URI>string</URI>
</Items>
<NextPage>string</NextPage>
</DigitalTaxInvoiceCollection>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | DigitalTaxInvoiceCollection |
get_expense_digitaltaxinvoices{id}
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/expense/digitaltaxinvoices/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://www.concursolutions.com/api/v3.0/expense/digitaltaxinvoices/{id} HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/digitaltaxinvoices/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/expense/digitaltaxinvoices/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/expense/digitaltaxinvoices/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/expense/digitaltaxinvoices/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/digitaltaxinvoices/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/expense/digitaltaxinvoices/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /expense/digitaltaxinvoices/{id}
Get a single digital tax invoice
Gets the specified digital tax invoice.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The ID of the digital tax invoice. |
Example responses
200 Response
{
"AccountID": "string",
"ConcurReceiptID": "string",
"DocumentID": "string",
"ReceiptData": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<DigitalTaxInvoiceGetSingle>
<AccountID>string</AccountID>
<ConcurReceiptID>string</ConcurReceiptID>
<DocumentID>string</DocumentID>
<ReceiptData>string</ReceiptData>
</DigitalTaxInvoiceGetSingle>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | DigitalTaxInvoiceGetSingle |
put_expense_digitaltaxinvoices{id}
Code samples
# You can also use wget
curl -X PUT https://www.concursolutions.com/api/v3.0/expense/digitaltaxinvoices/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
PUT https://www.concursolutions.com/api/v3.0/expense/digitaltaxinvoices/{id} HTTP/1.1
Host: www.concursolutions.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"Comment": "string",
"Status": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/digitaltaxinvoices/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put 'https://www.concursolutions.com/api/v3.0/expense/digitaltaxinvoices/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('https://www.concursolutions.com/api/v3.0/expense/digitaltaxinvoices/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','https://www.concursolutions.com/api/v3.0/expense/digitaltaxinvoices/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/digitaltaxinvoices/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://www.concursolutions.com/api/v3.0/expense/digitaltaxinvoices/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /expense/digitaltaxinvoices/{id}
Update a digital tax invoice
Updates the specified digital tax invoice.
Body parameter
{
"Comment": "string",
"Status": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<DigitalTaxInvoicePut>
<Comment>string</Comment>
<Status>string</Status>
</DigitalTaxInvoicePut>
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The ID of the digital tax invoice to update. |
| body | body | DigitalTaxInvoicePut | true | A status update for the digital tax invoice. |
Example responses
200 Response
{}
<?xml version="1.0" encoding="UTF-8" ?>
<Void/>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Void |
| 400 | Bad Request | Bad Request | Void |
Schemas
DigitalTaxInvoiceCollection
{
"Items": {
"ConcurReceiptID": "string",
"ID": "string",
"URI": "string"
},
"NextPage": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Items | DigitalTaxInvoiceGetAll | false | none | none |
| NextPage | string | false | none | The URI of the next page of results, if any. |
DigitalTaxInvoiceGetAll
{
"ConcurReceiptID": "string",
"ID": "string",
"URI": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ConcurReceiptID | string | false | none | The ID of the digital tax invoice in plain text. |
| ID | string | false | none | The unique identifier of the resource. |
| URI | string | false | none | The URI to the resource. |
DigitalTaxInvoiceGetSingle
{
"AccountID": "string",
"ConcurReceiptID": "string",
"DocumentID": "string",
"ReceiptData": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| AccountID | string | false | none | The unique identifier assigned by the validation partner to the SAP Concur client company that owns the digital tax invoices. |
| ConcurReceiptID | string | false | none | The ID of the digital tax invoice in plain text. |
| DocumentID | string | false | none | The ID of the report in plain text. |
| ReceiptData | string | false | none | The digital tax invoice data. |
DigitalTaxInvoicePut
{
"Comment": "string",
"Status": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Comment | string | false | none | A comment that describes the digital tax invoice status. Maximum length: 2000 characters |
| Status | string | false | none | A status that describes the digital tax invoice. Format: VALID - Valid; INVLD - Invalid; WARNG - Valid with warnings |
Void
{}
Properties
None
Entries v3.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Get all entries for a user, create new entries, update entries, or delete entries.
Base URLs:
Resources
get__expense_entries
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/expense/entries \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://www.concursolutions.com/api/v3.0/expense/entries HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/entries',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/expense/entries',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/expense/entries', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/expense/entries', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/entries");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/expense/entries", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /expense/entries
Get expense entries
Gets all expense entries owned by the user.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| reportID | query | string | false | The report ID of the entries to be retrieved. Format: An alpha-numeric GUID string. |
| paymentTypeID | query | string | false | The ID of the payment type of the entries to be retrieved. |
| batchID | query | string | false | The batch ID for the entries to be retrieved. The batch ID identifies the batch that contains the report payee associated with the entries. |
| isBillable | query | boolean | false | Determines whether the operation retrieves entries that are billable. Format: true or false |
| attendeeTypeCode | query | string | false | The ID of the attendee type for the entries to be retrieved. |
| hasAttendees | query | boolean | false | Determines whether the operation retrieves entries that have attendees. Format: true or false |
| hasVAT | query | boolean | false | Determines whether the operation retrieves entries that have VAT details. Format: true or false |
| expenseTypeCode | query | string | false | The code for the expense type for the entries to be retrieved. |
| attendeeID | query | string | false | The attendee associated with the entries to be retrieved. |
| offset | query | string | false | The starting point of the next set of results, after the limit specified in the limit field has been reached. |
| limit | query | integer(int32) | false | The number of records to return. Default value: 25 |
| user | query | string | false | The login ID of the user who owns the entries. The user must have the Web Services Admin role to use this parameter. |
Example responses
200 Response
{
"Items": {
"AllocationType": "string",
"ApprovedAmount": 0,
"CompanyCardTransactionID": "string",
"Custom1": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom2": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom3": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom4": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom5": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom6": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom7": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom8": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom9": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom10": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom11": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom12": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom13": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom14": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom15": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom16": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom17": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom18": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom19": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom20": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom21": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom22": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom23": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom24": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom25": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom26": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom27": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom28": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom29": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom30": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom31": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom32": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom33": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom34": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom35": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom36": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom37": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom38": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom39": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom40": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Description": "string",
"ElectronicReceiptID": "string",
"EmployeeBankAccountID": "string",
"ExchangeRate": 0,
"ExpenseTypeCode": "string",
"ExpenseTypeName": "string",
"FormID": "string",
"HasAppliedCashAdvance": true,
"HasAttendees": true,
"HasComments": true,
"HasExceptions": true,
"HasImage": true,
"HasItemizations": true,
"HasVAT": true,
"ID": "string",
"IsBillable": true,
"IsImageRequired": true,
"IsPaidByExpensePay": true,
"IsPersonal": true,
"IsPersonalCardCharge": true,
"Journey": {
"BusinessDistance": 0,
"EndLocation": "string",
"NumberOfPassengers": 0,
"OdometerEnd": 0,
"OdometerStart": 0,
"PersonalDistance": 0,
"StartLocation": "string",
"UnitOfMeasure": "string",
"VehicleID": "string"
},
"LastModified": "2019-08-24T14:15:22Z",
"LocationCountry": "string",
"LocationID": "string",
"LocationName": "string",
"LocationSubdivision": "string",
"OrgUnit1": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit2": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit3": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit4": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit5": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit6": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"PaymentTypeID": "string",
"PaymentTypeName": "string",
"PostedAmount": 0,
"ReceiptReceived": true,
"ReportID": "string",
"ReportOwnerID": "string",
"SpendCategoryCode": "string",
"SpendCategoryName": "string",
"TaxReceiptType": "string",
"TransactionAmount": 0,
"TransactionCurrencyCode": "string",
"TransactionDate": "2019-08-24T14:15:22Z",
"TripID": "string",
"URI": "string",
"VendorDescription": "string",
"VendorListItemID": "string",
"VendorListItemName": "string"
},
"NextPage": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<EntryCollection>
<Items>
<AllocationType>string</AllocationType>
<ApprovedAmount>0</ApprovedAmount>
<CompanyCardTransactionID>string</CompanyCardTransactionID>
<Custom1>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom1>
<Custom2>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom2>
<Custom3>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom3>
<Custom4>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom4>
<Custom5>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom5>
<Custom6>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom6>
<Custom7>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom7>
<Custom8>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom8>
<Custom9>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom9>
<Custom10>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom10>
<Custom11>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom11>
<Custom12>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom12>
<Custom13>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom13>
<Custom14>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom14>
<Custom15>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom15>
<Custom16>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom16>
<Custom17>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom17>
<Custom18>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom18>
<Custom19>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom19>
<Custom20>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom20>
<Custom21>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom21>
<Custom22>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom22>
<Custom23>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom23>
<Custom24>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom24>
<Custom25>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom25>
<Custom26>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom26>
<Custom27>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom27>
<Custom28>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom28>
<Custom29>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom29>
<Custom30>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom30>
<Custom31>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom31>
<Custom32>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom32>
<Custom33>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom33>
<Custom34>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom34>
<Custom35>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom35>
<Custom36>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom36>
<Custom37>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom37>
<Custom38>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom38>
<Custom39>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom39>
<Custom40>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom40>
<Description>string</Description>
<ElectronicReceiptID>string</ElectronicReceiptID>
<EmployeeBankAccountID>string</EmployeeBankAccountID>
<ExchangeRate>0</ExchangeRate>
<ExpenseTypeCode>string</ExpenseTypeCode>
<ExpenseTypeName>string</ExpenseTypeName>
<FormID>string</FormID>
<HasAppliedCashAdvance>true</HasAppliedCashAdvance>
<HasAttendees>true</HasAttendees>
<HasComments>true</HasComments>
<HasExceptions>true</HasExceptions>
<HasImage>true</HasImage>
<HasItemizations>true</HasItemizations>
<HasVAT>true</HasVAT>
<ID>string</ID>
<IsBillable>true</IsBillable>
<IsImageRequired>true</IsImageRequired>
<IsPaidByExpensePay>true</IsPaidByExpensePay>
<IsPersonal>true</IsPersonal>
<IsPersonalCardCharge>true</IsPersonalCardCharge>
<Journey>
<BusinessDistance>0</BusinessDistance>
<EndLocation>string</EndLocation>
<NumberOfPassengers>0</NumberOfPassengers>
<OdometerEnd>0</OdometerEnd>
<OdometerStart>0</OdometerStart>
<PersonalDistance>0</PersonalDistance>
<StartLocation>string</StartLocation>
<UnitOfMeasure>string</UnitOfMeasure>
<VehicleID>string</VehicleID>
</Journey>
<LastModified>2019-08-24T14:15:22Z</LastModified>
<LocationCountry>string</LocationCountry>
<LocationID>string</LocationID>
<LocationName>string</LocationName>
<LocationSubdivision>string</LocationSubdivision>
<OrgUnit1>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</OrgUnit1>
<OrgUnit2>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</OrgUnit2>
<OrgUnit3>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</OrgUnit3>
<OrgUnit4>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</OrgUnit4>
<OrgUnit5>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</OrgUnit5>
<OrgUnit6>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</OrgUnit6>
<PaymentTypeID>string</PaymentTypeID>
<PaymentTypeName>string</PaymentTypeName>
<PostedAmount>0</PostedAmount>
<ReceiptReceived>true</ReceiptReceived>
<ReportID>string</ReportID>
<ReportOwnerID>string</ReportOwnerID>
<SpendCategoryCode>string</SpendCategoryCode>
<SpendCategoryName>string</SpendCategoryName>
<TaxReceiptType>string</TaxReceiptType>
<TransactionAmount>0</TransactionAmount>
<TransactionCurrencyCode>string</TransactionCurrencyCode>
<TransactionDate>2019-08-24T14:15:22Z</TransactionDate>
<TripID>string</TripID>
<URI>string</URI>
<VendorDescription>string</VendorDescription>
<VendorListItemID>string</VendorListItemID>
<VendorListItemName>string</VendorListItemName>
</Items>
<NextPage>string</NextPage>
</EntryCollection>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | EntryCollection |
post__expense_entries
Code samples
# You can also use wget
curl -X POST https://www.concursolutions.com/api/v3.0/expense/entries \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://www.concursolutions.com/api/v3.0/expense/entries HTTP/1.1
Host: www.concursolutions.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"Comment": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom21": "string",
"Custom22": "string",
"Custom23": "string",
"Custom24": "string",
"Custom25": "string",
"Custom26": "string",
"Custom27": "string",
"Custom28": "string",
"Custom29": "string",
"Custom3": "string",
"Custom30": "string",
"Custom31": "string",
"Custom32": "string",
"Custom33": "string",
"Custom34": "string",
"Custom35": "string",
"Custom36": "string",
"Custom37": "string",
"Custom38": "string",
"Custom39": "string",
"Custom4": "string",
"Custom40": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Description": "string",
"ExchangeRate": 0,
"ExpenseTypeCode": "string",
"IsBillable": true,
"IsPersonal": true,
"Journey": {
"BusinessDistance": 0,
"EndLocation": "string",
"NumberOfPassengers": 0,
"OdometerEnd": 0,
"OdometerStart": 0,
"PersonalDistance": 0,
"StartLocation": "string",
"UnitOfMeasure": "string",
"VehicleID": "string"
},
"LocationID": "string",
"OrgUnit1": "string",
"OrgUnit2": "string",
"OrgUnit3": "string",
"OrgUnit4": "string",
"OrgUnit5": "string",
"OrgUnit6": "string",
"PaymentTypeID": "string",
"ReportID": "string",
"TaxReceiptType": "string",
"TransactionAmount": 0,
"TransactionCurrencyCode": "string",
"TransactionDate": "2019-08-24T14:15:22Z",
"VendorDescription": "string",
"VendorListItemID": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/entries',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://www.concursolutions.com/api/v3.0/expense/entries',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://www.concursolutions.com/api/v3.0/expense/entries', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://www.concursolutions.com/api/v3.0/expense/entries', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/entries");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://www.concursolutions.com/api/v3.0/expense/entries", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /expense/entries
Create expense entry
Creates a new expense entry for the specified user.
Body parameter
{
"Comment": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom21": "string",
"Custom22": "string",
"Custom23": "string",
"Custom24": "string",
"Custom25": "string",
"Custom26": "string",
"Custom27": "string",
"Custom28": "string",
"Custom29": "string",
"Custom3": "string",
"Custom30": "string",
"Custom31": "string",
"Custom32": "string",
"Custom33": "string",
"Custom34": "string",
"Custom35": "string",
"Custom36": "string",
"Custom37": "string",
"Custom38": "string",
"Custom39": "string",
"Custom4": "string",
"Custom40": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Description": "string",
"ExchangeRate": 0,
"ExpenseTypeCode": "string",
"IsBillable": true,
"IsPersonal": true,
"Journey": {
"BusinessDistance": 0,
"EndLocation": "string",
"NumberOfPassengers": 0,
"OdometerEnd": 0,
"OdometerStart": 0,
"PersonalDistance": 0,
"StartLocation": "string",
"UnitOfMeasure": "string",
"VehicleID": "string"
},
"LocationID": "string",
"OrgUnit1": "string",
"OrgUnit2": "string",
"OrgUnit3": "string",
"OrgUnit4": "string",
"OrgUnit5": "string",
"OrgUnit6": "string",
"PaymentTypeID": "string",
"ReportID": "string",
"TaxReceiptType": "string",
"TransactionAmount": 0,
"TransactionCurrencyCode": "string",
"TransactionDate": "2019-08-24T14:15:22Z",
"VendorDescription": "string",
"VendorListItemID": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<EntryPost>
<Comment>string</Comment>
<Custom1>string</Custom1>
<Custom10>string</Custom10>
<Custom11>string</Custom11>
<Custom12>string</Custom12>
<Custom13>string</Custom13>
<Custom14>string</Custom14>
<Custom15>string</Custom15>
<Custom16>string</Custom16>
<Custom17>string</Custom17>
<Custom18>string</Custom18>
<Custom19>string</Custom19>
<Custom2>string</Custom2>
<Custom20>string</Custom20>
<Custom21>string</Custom21>
<Custom22>string</Custom22>
<Custom23>string</Custom23>
<Custom24>string</Custom24>
<Custom25>string</Custom25>
<Custom26>string</Custom26>
<Custom27>string</Custom27>
<Custom28>string</Custom28>
<Custom29>string</Custom29>
<Custom3>string</Custom3>
<Custom30>string</Custom30>
<Custom31>string</Custom31>
<Custom32>string</Custom32>
<Custom33>string</Custom33>
<Custom34>string</Custom34>
<Custom35>string</Custom35>
<Custom36>string</Custom36>
<Custom37>string</Custom37>
<Custom38>string</Custom38>
<Custom39>string</Custom39>
<Custom4>string</Custom4>
<Custom40>string</Custom40>
<Custom5>string</Custom5>
<Custom6>string</Custom6>
<Custom7>string</Custom7>
<Custom8>string</Custom8>
<Custom9>string</Custom9>
<Description>string</Description>
<ExchangeRate>0</ExchangeRate>
<ExpenseTypeCode>string</ExpenseTypeCode>
<IsBillable>true</IsBillable>
<IsPersonal>true</IsPersonal>
<Journey>
<BusinessDistance>0</BusinessDistance>
<EndLocation>string</EndLocation>
<NumberOfPassengers>0</NumberOfPassengers>
<OdometerEnd>0</OdometerEnd>
<OdometerStart>0</OdometerStart>
<PersonalDistance>0</PersonalDistance>
<StartLocation>string</StartLocation>
<UnitOfMeasure>string</UnitOfMeasure>
<VehicleID>string</VehicleID>
</Journey>
<LocationID>string</LocationID>
<OrgUnit1>string</OrgUnit1>
<OrgUnit2>string</OrgUnit2>
<OrgUnit3>string</OrgUnit3>
<OrgUnit4>string</OrgUnit4>
<OrgUnit5>string</OrgUnit5>
<OrgUnit6>string</OrgUnit6>
<PaymentTypeID>string</PaymentTypeID>
<ReportID>string</ReportID>
<TaxReceiptType>string</TaxReceiptType>
<TransactionAmount>0</TransactionAmount>
<TransactionCurrencyCode>string</TransactionCurrencyCode>
<TransactionDate>2019-08-24T14:15:22Z</TransactionDate>
<VendorDescription>string</VendorDescription>
<VendorListItemID>string</VendorListItemID>
</EntryPost>
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| user | query | string | false | The login ID of the user who owns the entries. The user must have the Web Services Admin role to use this parameter. |
| body | body | EntryPost | true | The expense entry object to create. |
Example responses
200 Response
{
"ID": "string",
"URI": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CreateResponse>
<ID>string</ID>
<URI>string</URI>
</CreateResponse>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | CreateResponse |
| 400 | Bad Request | Bad Request | Void |
get_expense_entries{id}
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/expense/entries/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://www.concursolutions.com/api/v3.0/expense/entries/{id} HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/entries/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/expense/entries/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/expense/entries/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/expense/entries/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/entries/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/expense/entries/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /expense/entries/{id}
Get a single expense entry
Gets the specified expense entry.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The expense entry ID. |
| user | query | string | false | The login ID of the user who owns the entries. The user must have the Web Services Admin role to use this parameter. |
Example responses
200 Response
{
"AllocationType": "string",
"ApprovedAmount": 0,
"CompanyCardTransactionID": "string",
"Custom1": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom2": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom3": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom4": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom5": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom6": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom7": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom8": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom9": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom10": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom11": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom12": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom13": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom14": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom15": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom16": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom17": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom18": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom19": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom20": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom21": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom22": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom23": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom24": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom25": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom26": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom27": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom28": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom29": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom30": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom31": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom32": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom33": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom34": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom35": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom36": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom37": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom38": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom39": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom40": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Description": "string",
"ElectronicReceiptID": "string",
"EmployeeBankAccountID": "string",
"ExchangeRate": 0,
"ExpenseTypeCode": "string",
"ExpenseTypeName": "string",
"FormID": "string",
"HasAppliedCashAdvance": true,
"HasAttendees": true,
"HasComments": true,
"HasExceptions": true,
"HasImage": true,
"HasItemizations": true,
"HasVAT": true,
"ID": "string",
"IsBillable": true,
"IsImageRequired": true,
"IsPaidByExpensePay": true,
"IsPersonal": true,
"IsPersonalCardCharge": true,
"Journey": {
"BusinessDistance": 0,
"EndLocation": "string",
"NumberOfPassengers": 0,
"OdometerEnd": 0,
"OdometerStart": 0,
"PersonalDistance": 0,
"StartLocation": "string",
"UnitOfMeasure": "string",
"VehicleID": "string"
},
"LastModified": "2019-08-24T14:15:22Z",
"LocationCountry": "string",
"LocationID": "string",
"LocationName": "string",
"LocationSubdivision": "string",
"OrgUnit1": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit2": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit3": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit4": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit5": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit6": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"PaymentTypeID": "string",
"PaymentTypeName": "string",
"PostedAmount": 0,
"ReceiptReceived": true,
"ReportID": "string",
"ReportOwnerID": "string",
"SpendCategoryCode": "string",
"SpendCategoryName": "string",
"TaxReceiptType": "string",
"TransactionAmount": 0,
"TransactionCurrencyCode": "string",
"TransactionDate": "2019-08-24T14:15:22Z",
"TripID": "string",
"URI": "string",
"VendorDescription": "string",
"VendorListItemID": "string",
"VendorListItemName": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<EntryGet>
<AllocationType>string</AllocationType>
<ApprovedAmount>0</ApprovedAmount>
<CompanyCardTransactionID>string</CompanyCardTransactionID>
<Custom1>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom1>
<Custom2>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom2>
<Custom3>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom3>
<Custom4>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom4>
<Custom5>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom5>
<Custom6>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom6>
<Custom7>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom7>
<Custom8>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom8>
<Custom9>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom9>
<Custom10>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom10>
<Custom11>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom11>
<Custom12>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom12>
<Custom13>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom13>
<Custom14>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom14>
<Custom15>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom15>
<Custom16>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom16>
<Custom17>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom17>
<Custom18>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom18>
<Custom19>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom19>
<Custom20>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom20>
<Custom21>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom21>
<Custom22>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom22>
<Custom23>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom23>
<Custom24>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom24>
<Custom25>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom25>
<Custom26>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom26>
<Custom27>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom27>
<Custom28>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom28>
<Custom29>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom29>
<Custom30>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom30>
<Custom31>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom31>
<Custom32>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom32>
<Custom33>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom33>
<Custom34>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom34>
<Custom35>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom35>
<Custom36>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom36>
<Custom37>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom37>
<Custom38>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom38>
<Custom39>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom39>
<Custom40>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom40>
<Description>string</Description>
<ElectronicReceiptID>string</ElectronicReceiptID>
<EmployeeBankAccountID>string</EmployeeBankAccountID>
<ExchangeRate>0</ExchangeRate>
<ExpenseTypeCode>string</ExpenseTypeCode>
<ExpenseTypeName>string</ExpenseTypeName>
<FormID>string</FormID>
<HasAppliedCashAdvance>true</HasAppliedCashAdvance>
<HasAttendees>true</HasAttendees>
<HasComments>true</HasComments>
<HasExceptions>true</HasExceptions>
<HasImage>true</HasImage>
<HasItemizations>true</HasItemizations>
<HasVAT>true</HasVAT>
<ID>string</ID>
<IsBillable>true</IsBillable>
<IsImageRequired>true</IsImageRequired>
<IsPaidByExpensePay>true</IsPaidByExpensePay>
<IsPersonal>true</IsPersonal>
<IsPersonalCardCharge>true</IsPersonalCardCharge>
<Journey>
<BusinessDistance>0</BusinessDistance>
<EndLocation>string</EndLocation>
<NumberOfPassengers>0</NumberOfPassengers>
<OdometerEnd>0</OdometerEnd>
<OdometerStart>0</OdometerStart>
<PersonalDistance>0</PersonalDistance>
<StartLocation>string</StartLocation>
<UnitOfMeasure>string</UnitOfMeasure>
<VehicleID>string</VehicleID>
</Journey>
<LastModified>2019-08-24T14:15:22Z</LastModified>
<LocationCountry>string</LocationCountry>
<LocationID>string</LocationID>
<LocationName>string</LocationName>
<LocationSubdivision>string</LocationSubdivision>
<OrgUnit1>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</OrgUnit1>
<OrgUnit2>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</OrgUnit2>
<OrgUnit3>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</OrgUnit3>
<OrgUnit4>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</OrgUnit4>
<OrgUnit5>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</OrgUnit5>
<OrgUnit6>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</OrgUnit6>
<PaymentTypeID>string</PaymentTypeID>
<PaymentTypeName>string</PaymentTypeName>
<PostedAmount>0</PostedAmount>
<ReceiptReceived>true</ReceiptReceived>
<ReportID>string</ReportID>
<ReportOwnerID>string</ReportOwnerID>
<SpendCategoryCode>string</SpendCategoryCode>
<SpendCategoryName>string</SpendCategoryName>
<TaxReceiptType>string</TaxReceiptType>
<TransactionAmount>0</TransactionAmount>
<TransactionCurrencyCode>string</TransactionCurrencyCode>
<TransactionDate>2019-08-24T14:15:22Z</TransactionDate>
<TripID>string</TripID>
<URI>string</URI>
<VendorDescription>string</VendorDescription>
<VendorListItemID>string</VendorListItemID>
<VendorListItemName>string</VendorListItemName>
</EntryGet>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | EntryGet |
put_expense_entries{id}
Code samples
# You can also use wget
curl -X PUT https://www.concursolutions.com/api/v3.0/expense/entries/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
PUT https://www.concursolutions.com/api/v3.0/expense/entries/{id} HTTP/1.1
Host: www.concursolutions.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"Comment": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom21": "string",
"Custom22": "string",
"Custom23": "string",
"Custom24": "string",
"Custom25": "string",
"Custom26": "string",
"Custom27": "string",
"Custom28": "string",
"Custom29": "string",
"Custom3": "string",
"Custom30": "string",
"Custom31": "string",
"Custom32": "string",
"Custom33": "string",
"Custom34": "string",
"Custom35": "string",
"Custom36": "string",
"Custom37": "string",
"Custom38": "string",
"Custom39": "string",
"Custom4": "string",
"Custom40": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Description": "string",
"ExchangeRate": 0,
"ExpenseTypeCode": "string",
"IsBillable": true,
"IsPersonal": true,
"Journey": {
"BusinessDistance": 0,
"EndLocation": "string",
"NumberOfPassengers": 0,
"OdometerEnd": 0,
"OdometerStart": 0,
"PersonalDistance": 0,
"StartLocation": "string",
"UnitOfMeasure": "string",
"VehicleID": "string"
},
"LocationID": "string",
"OrgUnit1": "string",
"OrgUnit2": "string",
"OrgUnit3": "string",
"OrgUnit4": "string",
"OrgUnit5": "string",
"OrgUnit6": "string",
"PaymentTypeID": "string",
"ReportID": "string",
"TaxReceiptType": "string",
"TransactionAmount": 0,
"TransactionCurrencyCode": "string",
"TransactionDate": "2019-08-24T14:15:22Z",
"VendorDescription": "string",
"VendorListItemID": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/entries/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put 'https://www.concursolutions.com/api/v3.0/expense/entries/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('https://www.concursolutions.com/api/v3.0/expense/entries/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','https://www.concursolutions.com/api/v3.0/expense/entries/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/entries/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://www.concursolutions.com/api/v3.0/expense/entries/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /expense/entries/{id}
Update an expense entry
Updates the specified expense entry. Only the fields provided in the supplied object are updated. Missing fields will not be altered.
Body parameter
{
"Comment": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom21": "string",
"Custom22": "string",
"Custom23": "string",
"Custom24": "string",
"Custom25": "string",
"Custom26": "string",
"Custom27": "string",
"Custom28": "string",
"Custom29": "string",
"Custom3": "string",
"Custom30": "string",
"Custom31": "string",
"Custom32": "string",
"Custom33": "string",
"Custom34": "string",
"Custom35": "string",
"Custom36": "string",
"Custom37": "string",
"Custom38": "string",
"Custom39": "string",
"Custom4": "string",
"Custom40": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Description": "string",
"ExchangeRate": 0,
"ExpenseTypeCode": "string",
"IsBillable": true,
"IsPersonal": true,
"Journey": {
"BusinessDistance": 0,
"EndLocation": "string",
"NumberOfPassengers": 0,
"OdometerEnd": 0,
"OdometerStart": 0,
"PersonalDistance": 0,
"StartLocation": "string",
"UnitOfMeasure": "string",
"VehicleID": "string"
},
"LocationID": "string",
"OrgUnit1": "string",
"OrgUnit2": "string",
"OrgUnit3": "string",
"OrgUnit4": "string",
"OrgUnit5": "string",
"OrgUnit6": "string",
"PaymentTypeID": "string",
"ReportID": "string",
"TaxReceiptType": "string",
"TransactionAmount": 0,
"TransactionCurrencyCode": "string",
"TransactionDate": "2019-08-24T14:15:22Z",
"VendorDescription": "string",
"VendorListItemID": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<EntryPut>
<Comment>string</Comment>
<Custom1>string</Custom1>
<Custom10>string</Custom10>
<Custom11>string</Custom11>
<Custom12>string</Custom12>
<Custom13>string</Custom13>
<Custom14>string</Custom14>
<Custom15>string</Custom15>
<Custom16>string</Custom16>
<Custom17>string</Custom17>
<Custom18>string</Custom18>
<Custom19>string</Custom19>
<Custom2>string</Custom2>
<Custom20>string</Custom20>
<Custom21>string</Custom21>
<Custom22>string</Custom22>
<Custom23>string</Custom23>
<Custom24>string</Custom24>
<Custom25>string</Custom25>
<Custom26>string</Custom26>
<Custom27>string</Custom27>
<Custom28>string</Custom28>
<Custom29>string</Custom29>
<Custom3>string</Custom3>
<Custom30>string</Custom30>
<Custom31>string</Custom31>
<Custom32>string</Custom32>
<Custom33>string</Custom33>
<Custom34>string</Custom34>
<Custom35>string</Custom35>
<Custom36>string</Custom36>
<Custom37>string</Custom37>
<Custom38>string</Custom38>
<Custom39>string</Custom39>
<Custom4>string</Custom4>
<Custom40>string</Custom40>
<Custom5>string</Custom5>
<Custom6>string</Custom6>
<Custom7>string</Custom7>
<Custom8>string</Custom8>
<Custom9>string</Custom9>
<Description>string</Description>
<ExchangeRate>0</ExchangeRate>
<ExpenseTypeCode>string</ExpenseTypeCode>
<IsBillable>true</IsBillable>
<IsPersonal>true</IsPersonal>
<Journey>
<BusinessDistance>0</BusinessDistance>
<EndLocation>string</EndLocation>
<NumberOfPassengers>0</NumberOfPassengers>
<OdometerEnd>0</OdometerEnd>
<OdometerStart>0</OdometerStart>
<PersonalDistance>0</PersonalDistance>
<StartLocation>string</StartLocation>
<UnitOfMeasure>string</UnitOfMeasure>
<VehicleID>string</VehicleID>
</Journey>
<LocationID>string</LocationID>
<OrgUnit1>string</OrgUnit1>
<OrgUnit2>string</OrgUnit2>
<OrgUnit3>string</OrgUnit3>
<OrgUnit4>string</OrgUnit4>
<OrgUnit5>string</OrgUnit5>
<OrgUnit6>string</OrgUnit6>
<PaymentTypeID>string</PaymentTypeID>
<ReportID>string</ReportID>
<TaxReceiptType>string</TaxReceiptType>
<TransactionAmount>0</TransactionAmount>
<TransactionCurrencyCode>string</TransactionCurrencyCode>
<TransactionDate>2019-08-24T14:15:22Z</TransactionDate>
<VendorDescription>string</VendorDescription>
<VendorListItemID>string</VendorListItemID>
</EntryPut>
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The expense entry ID. |
| user | query | string | false | The login ID of the user who owns the entries. The user must have the Web Services Admin role to use this parameter. |
| body | body | EntryPut | true | The partial or complete expense entry object to update. |
Example responses
200 Response
{}
<?xml version="1.0" encoding="UTF-8" ?>
<Void/>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Void |
| 400 | Bad Request | Bad Request | Void |
delete_expense_entries{id}
Code samples
# You can also use wget
curl -X DELETE https://www.concursolutions.com/api/v3.0/expense/entries/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
DELETE https://www.concursolutions.com/api/v3.0/expense/entries/{id} HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/entries/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://www.concursolutions.com/api/v3.0/expense/entries/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://www.concursolutions.com/api/v3.0/expense/entries/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','https://www.concursolutions.com/api/v3.0/expense/entries/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/entries/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://www.concursolutions.com/api/v3.0/expense/entries/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /expense/entries/{id}
Delete an expense entry
Deletes the specified expense entry.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The ID of the expense entry to delete. |
| user | query | string | false | The login ID of the user who owns the entries. The user must have the Web Services Admin role to use this parameter. |
Example responses
200 Response
{}
<?xml version="1.0" encoding="UTF-8" ?>
<Void/>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Void |
Schemas
CreateResponse
{
"ID": "string",
"URI": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ID | string | false | none | none |
| URI | string | false | none | none |
CustomField
{
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Code | string | false | none | For list fields, this is the list item code. |
| ListItemID | string | false | none | For list fields, this is the list item ID. |
| Type | string | false | none | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text |
| Value | string | false | none | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters |
EntryCollection
{
"Items": {
"AllocationType": "string",
"ApprovedAmount": 0,
"CompanyCardTransactionID": "string",
"Custom1": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom2": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom3": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom4": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom5": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom6": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom7": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom8": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom9": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom10": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom11": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom12": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom13": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom14": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom15": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom16": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom17": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom18": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom19": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom20": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom21": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom22": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom23": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom24": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom25": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom26": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom27": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom28": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom29": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom30": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom31": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom32": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom33": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom34": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom35": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom36": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom37": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom38": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom39": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom40": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Description": "string",
"ElectronicReceiptID": "string",
"EmployeeBankAccountID": "string",
"ExchangeRate": 0,
"ExpenseTypeCode": "string",
"ExpenseTypeName": "string",
"FormID": "string",
"HasAppliedCashAdvance": true,
"HasAttendees": true,
"HasComments": true,
"HasExceptions": true,
"HasImage": true,
"HasItemizations": true,
"HasVAT": true,
"ID": "string",
"IsBillable": true,
"IsImageRequired": true,
"IsPaidByExpensePay": true,
"IsPersonal": true,
"IsPersonalCardCharge": true,
"Journey": {
"BusinessDistance": 0,
"EndLocation": "string",
"NumberOfPassengers": 0,
"OdometerEnd": 0,
"OdometerStart": 0,
"PersonalDistance": 0,
"StartLocation": "string",
"UnitOfMeasure": "string",
"VehicleID": "string"
},
"LastModified": "2019-08-24T14:15:22Z",
"LocationCountry": "string",
"LocationID": "string",
"LocationName": "string",
"LocationSubdivision": "string",
"OrgUnit1": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit2": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit3": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit4": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit5": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit6": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"PaymentTypeID": "string",
"PaymentTypeName": "string",
"PostedAmount": 0,
"ReceiptReceived": true,
"ReportID": "string",
"ReportOwnerID": "string",
"SpendCategoryCode": "string",
"SpendCategoryName": "string",
"TaxReceiptType": "string",
"TransactionAmount": 0,
"TransactionCurrencyCode": "string",
"TransactionDate": "2019-08-24T14:15:22Z",
"TripID": "string",
"URI": "string",
"VendorDescription": "string",
"VendorListItemID": "string",
"VendorListItemName": "string"
},
"NextPage": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Items | EntryGet | false | none | none |
| NextPage | string | false | none | The URI of the next page of results, if any. |
EntryGet
{
"AllocationType": "string",
"ApprovedAmount": 0,
"CompanyCardTransactionID": "string",
"Custom1": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom2": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom3": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom4": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom5": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom6": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom7": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom8": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom9": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom10": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom11": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom12": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom13": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom14": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom15": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom16": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom17": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom18": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom19": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom20": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom21": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom22": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom23": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom24": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom25": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom26": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom27": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom28": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom29": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom30": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom31": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom32": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom33": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom34": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom35": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom36": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom37": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom38": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom39": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom40": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Description": "string",
"ElectronicReceiptID": "string",
"EmployeeBankAccountID": "string",
"ExchangeRate": 0,
"ExpenseTypeCode": "string",
"ExpenseTypeName": "string",
"FormID": "string",
"HasAppliedCashAdvance": true,
"HasAttendees": true,
"HasComments": true,
"HasExceptions": true,
"HasImage": true,
"HasItemizations": true,
"HasVAT": true,
"ID": "string",
"IsBillable": true,
"IsImageRequired": true,
"IsPaidByExpensePay": true,
"IsPersonal": true,
"IsPersonalCardCharge": true,
"Journey": {
"BusinessDistance": 0,
"EndLocation": "string",
"NumberOfPassengers": 0,
"OdometerEnd": 0,
"OdometerStart": 0,
"PersonalDistance": 0,
"StartLocation": "string",
"UnitOfMeasure": "string",
"VehicleID": "string"
},
"LastModified": "2019-08-24T14:15:22Z",
"LocationCountry": "string",
"LocationID": "string",
"LocationName": "string",
"LocationSubdivision": "string",
"OrgUnit1": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit2": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit3": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit4": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit5": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit6": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"PaymentTypeID": "string",
"PaymentTypeName": "string",
"PostedAmount": 0,
"ReceiptReceived": true,
"ReportID": "string",
"ReportOwnerID": "string",
"SpendCategoryCode": "string",
"SpendCategoryName": "string",
"TaxReceiptType": "string",
"TransactionAmount": 0,
"TransactionCurrencyCode": "string",
"TransactionDate": "2019-08-24T14:15:22Z",
"TripID": "string",
"URI": "string",
"VendorDescription": "string",
"VendorListItemID": "string",
"VendorListItemName": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| AllocationType | string | false | none | The type of allocations for the expense. Supported values: P - partial allocation, F - full allocation, N - no allocation. |
| ApprovedAmount | number(double) | false | none | The approved amount of the expense entry, in the report currency. |
| CompanyCardTransactionID | string | false | none | The unique identifier for a company card transaction that is associated with this expense. This element is null when there is no company card transaction associated with this expense. |
| Custom1 | CustomField | false | none | none |
| Custom2 | CustomField | false | none | none |
| Custom3 | CustomField | false | none | none |
| Custom4 | CustomField | false | none | none |
| Custom5 | CustomField | false | none | none |
| Custom6 | CustomField | false | none | none |
| Custom7 | CustomField | false | none | none |
| Custom8 | CustomField | false | none | none |
| Custom9 | CustomField | false | none | none |
| Custom10 | CustomField | false | none | none |
| Custom11 | CustomField | false | none | none |
| Custom12 | CustomField | false | none | none |
| Custom13 | CustomField | false | none | none |
| Custom14 | CustomField | false | none | none |
| Custom15 | CustomField | false | none | none |
| Custom16 | CustomField | false | none | none |
| Custom17 | CustomField | false | none | none |
| Custom18 | CustomField | false | none | none |
| Custom19 | CustomField | false | none | none |
| Custom20 | CustomField | false | none | none |
| Custom21 | CustomField | false | none | none |
| Custom22 | CustomField | false | none | none |
| Custom23 | CustomField | false | none | none |
| Custom24 | CustomField | false | none | none |
| Custom25 | CustomField | false | none | none |
| Custom26 | CustomField | false | none | none |
| Custom27 | CustomField | false | none | none |
| Custom28 | CustomField | false | none | none |
| Custom29 | CustomField | false | none | none |
| Custom30 | CustomField | false | none | none |
| Custom31 | CustomField | false | none | none |
| Custom32 | CustomField | false | none | none |
| Custom33 | CustomField | false | none | none |
| Custom34 | CustomField | false | none | none |
| Custom35 | CustomField | false | none | none |
| Custom36 | CustomField | false | none | none |
| Custom37 | CustomField | false | none | none |
| Custom38 | CustomField | false | none | none |
| Custom39 | CustomField | false | none | none |
| Custom40 | CustomField | false | none | none |
| Description | string | false | none | The description of the expense. Maximum length: 64 characters |
| ElectronicReceiptID | string | false | none | The unique identifier for an eReceipt that is associated with this expense. This element is null when there is no eReceipt associated with this expense. |
| EmployeeBankAccountID | string | false | none | The unique identifier of an employee bank account that is associated with this expense. Typically, this element is used when Expense Pay reimburses the employee for this expense. |
| ExchangeRate | number(double) | false | none | The currency conversion rate that converts the transaction amount that is in the transaction currency into the posted amount that is in the report currency. This element is typically not provided. If this element is empty for transactions in a currency different than the user's reimbursement currency, Expense will use the company's configured exchange rates to determine the posted amount for the transaction. If the system is not able to determine the exchange rate, a value of 1.0 will be used. |
| ExpenseTypeCode | string | false | none | The code for the expense type. |
| ExpenseTypeName | string | false | none | The name of the expense type, localized to the user's language. |
| FormID | string | false | none | The ID of the form used by this expense entry. |
| HasAppliedCashAdvance | boolean | false | none | Whether the entry has a cash advance applied to it. Format: true or false |
| HasAttendees | boolean | false | none | Indicates whether the expense has attendees. Format: true or false |
| HasComments | boolean | false | none | Whether the expense has comments. Format: true or false |
| HasExceptions | boolean | false | none | Whether the expense has exceptions. Format: true or false |
| HasImage | boolean | false | none | Indicates whether there is an entry image attached to the entry. Format: true or false |
| HasItemizations | boolean | false | none | Indicates whether the expense has itemizations. Use the Format: true or false |
| HasVAT | boolean | false | none | Indicates whether the entry has VAT data. Format: true or false |
| ID | string | false | none | The unique identifier of the resource. |
| IsBillable | boolean | false | none | Indicates whether the expense is billable. Format: true or false |
| IsImageRequired | boolean | false | none | Indicates whether an entry image is required for the entry. Format: true or false |
| IsPaidByExpensePay | boolean | false | none | Whether the entry is paid using the Expense Pay service. This element has a value if the report has reached the Processing Payment workflow step, because this is when Concur Expense determines whether it will be paid by Expense Pay. Format: true or false |
| IsPersonal | boolean | false | none | Indicates whether the expense is personal (that is, non-reimbursable). Format: true or false |
| IsPersonalCardCharge | boolean | false | none | Indicates whether the expense entry was imported from a personal card feed. Format: true or false |
| Journey | Journey | false | none | none |
| LastModified | string(date-time) | false | none | The UTC date when the entry was last modified. |
| LocationCountry | string | false | none | The 2-letter ISO 3166-1 country code where the expense was incurred. |
| LocationID | string | false | none | The unique identifier for the location where the expense was incurred. |
| LocationName | string | false | none | The location where the expense was incurred, usually the city name. |
| LocationSubdivision | string | false | none | The ISO 3166-2:2007 country subdivision state, province, or other country subdivision where the expense was incurred. |
| OrgUnit1 | CustomField | false | none | none |
| OrgUnit2 | CustomField | false | none | none |
| OrgUnit3 | CustomField | false | none | none |
| OrgUnit4 | CustomField | false | none | none |
| OrgUnit5 | CustomField | false | none | none |
| OrgUnit6 | CustomField | false | none | none |
| PaymentTypeID | string | false | none | The ID of the payment type for the entry. For mileage expenses, use the Cash payment type. For expense types with an expense code that uses a transaction amount instead of a distance, this element is required. This element should not be used for expense types with an expense code for Company Car or Personal Car, because these two expense codes always use the Cash payment type. |
| PaymentTypeName | string | false | none | The name of the payment type, localized to the user's language. |
| PostedAmount | number(double) | false | none | The amount of the expense entry, in the report currency. |
| ReceiptReceived | boolean | false | none | Indicates whether this entry has been reviewed by a processor. Format: true or false |
| ReportID | string | false | none | The report ID of the report where the entry will be added. |
| ReportOwnerID | string | false | none | The login ID of the report owner. |
| SpendCategoryCode | string | false | none | The ID of the spending category that is specified for this expense entry. |
| SpendCategoryName | string | false | none | The name of the spending category that is specified for this expense entry, localized to the user's language. |
| TaxReceiptType | string | false | none | The receipt type for this entry. Supported values: T - tax receipt, R - regular receipt, N - no receipt |
| TransactionAmount | number(double) | false | none | The amount of the expense entry, in the transaction currency paid to the vendor. For expense types with an expense code that uses a transaction amount instead of a distance, this element is required. This element should not be used for expense types with an expense code for Company Car or Personal Car, because these two expense codes use a distance instead of a transaction amount. |
| TransactionCurrencyCode | string | false | none | The 3-letter ISO 4217 currency code for the expense entry transaction amount. This is the currency in which the vendor was paid. For expense types with an expense code that uses a transaction amount instead of a distance, this element is required. This element should not be used for expense types with an expense code for Company Car or Personal Car, because for these two expense codes the currency is always the Report Currency. |
| TransactionDate | string(date-time) | false | none | The date when the good or service associated with this expense entry was provided. Format: YYYY-MM-DD |
| TripID | string | false | none | The unique identifier of a trip in the Itinerary Service that includes a travel booking associated with this expense. This element is null when there is no trip associated with the expense. |
| URI | string | false | none | The URI to the resource. |
| VendorDescription | string | false | none | The name of the vendor for the expense entry. Maximum length: 64 characters |
| VendorListItemID | string | false | none | The unique identifier for a vendor list item. |
| VendorListItemName | string | false | none | The name of an item from a vendor list. |
EntryPost
{
"Comment": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom21": "string",
"Custom22": "string",
"Custom23": "string",
"Custom24": "string",
"Custom25": "string",
"Custom26": "string",
"Custom27": "string",
"Custom28": "string",
"Custom29": "string",
"Custom3": "string",
"Custom30": "string",
"Custom31": "string",
"Custom32": "string",
"Custom33": "string",
"Custom34": "string",
"Custom35": "string",
"Custom36": "string",
"Custom37": "string",
"Custom38": "string",
"Custom39": "string",
"Custom4": "string",
"Custom40": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Description": "string",
"ExchangeRate": 0,
"ExpenseTypeCode": "string",
"IsBillable": true,
"IsPersonal": true,
"Journey": {
"BusinessDistance": 0,
"EndLocation": "string",
"NumberOfPassengers": 0,
"OdometerEnd": 0,
"OdometerStart": 0,
"PersonalDistance": 0,
"StartLocation": "string",
"UnitOfMeasure": "string",
"VehicleID": "string"
},
"LocationID": "string",
"OrgUnit1": "string",
"OrgUnit2": "string",
"OrgUnit3": "string",
"OrgUnit4": "string",
"OrgUnit5": "string",
"OrgUnit6": "string",
"PaymentTypeID": "string",
"ReportID": "string",
"TaxReceiptType": "string",
"TransactionAmount": 0,
"TransactionCurrencyCode": "string",
"TransactionDate": "2019-08-24T14:15:22Z",
"VendorDescription": "string",
"VendorListItemID": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Comment | string | false | none | A comment that describes the expense entry. Maximum length: 500 characters |
| Custom1 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom10 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom11 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom12 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom13 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom14 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom15 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom16 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom17 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom18 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom19 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom2 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom20 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom21 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom22 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom23 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom24 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom25 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom26 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom27 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom28 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom29 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom3 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom30 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom31 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom32 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom33 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom34 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom35 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom36 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom37 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom38 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom39 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom4 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom40 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom5 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom6 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom7 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom8 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom9 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Description | string | false | none | The description of the expense. Maximum length: 64 characters |
| ExchangeRate | number(double) | false | none | The currency conversion rate that converts the transaction amount that is in the transaction currency into the posted amount that is in the report currency. This element is typically not provided. If this element is empty for transactions in a currency different than the user's reimbursement currency, Expense will use the company's configured exchange rates to determine the posted amount for the transaction. If the system is not able to determine the exchange rate, a value of 1.0 will be used. |
| ExpenseTypeCode | string | false | none | The code for the expense type. Use "GET /expense/expensegroupconfigurations" to learn the expense type code for expense types that are active for this report's policy. |
| IsBillable | boolean | false | none | Indicates whether the expense is billable. Format: true or false |
| IsPersonal | boolean | false | none | Indicates whether the expense is personal (that is, non-reimbursable). Format: true or false |
| Journey | Journey | false | none | none |
| LocationID | string | false | none | The unique identifier for the location where the expense was incurred. Use the "GET /common/locations" function to get information for this location. |
| OrgUnit1 | string | false | none | The details from the Org Unit fields. These fields may not have data, depending on the configuration. |
| OrgUnit2 | string | false | none | The details from the Org Unit fields. These fields may not have data, depending on the configuration. |
| OrgUnit3 | string | false | none | The details from the Org Unit fields. These fields may not have data, depending on the configuration. |
| OrgUnit4 | string | false | none | The details from the Org Unit fields. These fields may not have data, depending on the configuration. |
| OrgUnit5 | string | false | none | The details from the Org Unit fields. These fields may not have data, depending on the configuration. |
| OrgUnit6 | string | false | none | The details from the Org Unit fields. These fields may not have data, depending on the configuration. |
| PaymentTypeID | string | false | none | The ID of the payment type for the entry. For mileage expenses, use the Cash payment type. For expense types with an expense code that uses a transaction amount instead of a distance, this element is required. This element should not be used for expense types with an expense code for Company Car or Personal Car, because these two expense codes always use the Cash payment type. |
| ReportID | string | false | none | The report ID of the report where the entry will be added. |
| TaxReceiptType | string | false | none | The receipt type for this entry. Supported values: T - tax receipt, R - regular receipt, N - no receipt |
| TransactionAmount | number(double) | false | none | The amount of the expense entry, in the transaction currency paid to the vendor. For expense types with an expense code that uses a transaction amount instead of a distance, this element is required. This element should not be used for expense types with an expense code for Company Car or Personal Car, because these two expense codes use a distance instead of a transaction amount. |
| TransactionCurrencyCode | string | false | none | The 3-letter ISO 4217 currency code for the expense entry transaction amount. This is the currency in which the vendor was paid. For expense types with an expense code that uses a transaction amount instead of a distance, this element is required. This element should not be used for expense types with an expense code for Company Car or Personal Car, because for these two expense codes the currency is always the Report Currency. |
| TransactionDate | string(date-time) | false | none | The date when the good or service associated with this expense entry was provided. Format: YYYY-MM-DD |
| VendorDescription | string | false | none | The name of the vendor for the expense entry. Maximum length: 64 characters |
| VendorListItemID | string | false | none | The unique identifier for a vendor list item. |
EntryPut
{
"Comment": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom21": "string",
"Custom22": "string",
"Custom23": "string",
"Custom24": "string",
"Custom25": "string",
"Custom26": "string",
"Custom27": "string",
"Custom28": "string",
"Custom29": "string",
"Custom3": "string",
"Custom30": "string",
"Custom31": "string",
"Custom32": "string",
"Custom33": "string",
"Custom34": "string",
"Custom35": "string",
"Custom36": "string",
"Custom37": "string",
"Custom38": "string",
"Custom39": "string",
"Custom4": "string",
"Custom40": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Description": "string",
"ExchangeRate": 0,
"ExpenseTypeCode": "string",
"IsBillable": true,
"IsPersonal": true,
"Journey": {
"BusinessDistance": 0,
"EndLocation": "string",
"NumberOfPassengers": 0,
"OdometerEnd": 0,
"OdometerStart": 0,
"PersonalDistance": 0,
"StartLocation": "string",
"UnitOfMeasure": "string",
"VehicleID": "string"
},
"LocationID": "string",
"OrgUnit1": "string",
"OrgUnit2": "string",
"OrgUnit3": "string",
"OrgUnit4": "string",
"OrgUnit5": "string",
"OrgUnit6": "string",
"PaymentTypeID": "string",
"ReportID": "string",
"TaxReceiptType": "string",
"TransactionAmount": 0,
"TransactionCurrencyCode": "string",
"TransactionDate": "2019-08-24T14:15:22Z",
"VendorDescription": "string",
"VendorListItemID": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Comment | string | false | none | A comment that describes the expense entry. Maximum length: 500 characters |
| Custom1 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom10 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom11 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom12 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom13 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom14 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom15 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom16 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom17 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom18 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom19 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom2 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom20 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom21 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom22 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom23 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom24 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom25 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom26 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom27 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom28 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom29 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom3 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom30 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom31 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom32 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom33 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom34 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom35 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom36 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom37 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom38 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom39 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom4 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom40 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom5 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom6 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom7 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom8 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom9 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Description | string | false | none | The description of the expense. Maximum length: 64 characters |
| ExchangeRate | number(double) | false | none | The currency conversion rate that converts the transaction amount that is in the transaction currency into the posted amount that is in the report currency. This element is typically not provided. If this element is empty for transactions in a currency different than the user's reimbursement currency, Expense will use the company's configured exchange rates to determine the posted amount for the transaction. If the system is not able to determine the exchange rate, a value of 1.0 will be used. |
| ExpenseTypeCode | string | false | none | The code for the expense type. |
| IsBillable | boolean | false | none | Indicates whether the expense is billable. Format: true or false |
| IsPersonal | boolean | false | none | Indicates whether the expense is personal (that is, non-reimbursable). Format: true or false |
| Journey | Journey | false | none | none |
| LocationID | string | false | none | The unique identifier for the location where the expense was incurred. |
| OrgUnit1 | string | false | none | The details from the Org Unit fields. These fields may not have data, depending on the configuration. |
| OrgUnit2 | string | false | none | The details from the Org Unit fields. These fields may not have data, depending on the configuration. |
| OrgUnit3 | string | false | none | The details from the Org Unit fields. These fields may not have data, depending on the configuration. |
| OrgUnit4 | string | false | none | The details from the Org Unit fields. These fields may not have data, depending on the configuration. |
| OrgUnit5 | string | false | none | The details from the Org Unit fields. These fields may not have data, depending on the configuration. |
| OrgUnit6 | string | false | none | The details from the Org Unit fields. These fields may not have data, depending on the configuration. |
| PaymentTypeID | string | false | none | The ID of the payment type for the entry. For mileage expenses, use the Cash payment type. For expense types with an expense code that uses a transaction amount instead of a distance, this element is required. This element should not be used for expense types with an expense code for Company Car or Personal Car, because these two expense codes always use the Cash payment type. |
| ReportID | string | false | none | The report ID of the report where the entry will be added. |
| TaxReceiptType | string | false | none | The receipt type for this entry. Supported values: T - tax receipt, R - regular receipt, N - no receipt |
| TransactionAmount | number(double) | false | none | The amount of the expense entry, in the transaction currency paid to the vendor. For expense types with an expense code that uses a transaction amount instead of a distance, this element is required. This element should not be used for expense types with an expense code for Company Car or Personal Car, because these two expense codes use a distance instead of a transaction amount. |
| TransactionCurrencyCode | string | false | none | The 3-letter ISO 4217 currency code for the expense entry transaction amount. This is the currency in which the vendor was paid. For expense types with an expense code that uses a transaction amount instead of a distance, this element is required. This element should not be used for expense types with an expense code for Company Car or Personal Car, because for these two expense codes the currency is always the Report Currency. |
| TransactionDate | string(date-time) | false | none | The date when the good or service associated with this expense entry was provided. Format: YYYY-MM-DD |
| VendorDescription | string | false | none | The name of the vendor for the expense entry. Maximum length: 64 characters |
| VendorListItemID | string | false | none | The unique identifier for a vendor list item. |
Journey
{
"BusinessDistance": 0,
"EndLocation": "string",
"NumberOfPassengers": 0,
"OdometerEnd": 0,
"OdometerStart": 0,
"PersonalDistance": 0,
"StartLocation": "string",
"UnitOfMeasure": "string",
"VehicleID": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| BusinessDistance | integer(int32) | false | none | The portion of the journey for business use, in the report owner's unit of measure for distances. This element is required in order to post a personal car mileage expense entry, or to post a company car mileage expense when there is no PersonalDistance value. When using the Odometer elements, the sum of PersonalDistance and BusinessDistance must equal the difference between OdometerEnd and OdometerStart. |
| EndLocation | string | false | none | Indicates where the journey ended. This is also known as the "To Location". Maximum length: 100 characters |
| NumberOfPassengers | integer(int32) | false | none | The number of people in the vehicle during the journey. Used with Variable-Rate, Personal or Company Car. |
| OdometerEnd | integer(int32) | false | none | The odometer reading at the end of the journey. The value must be greater than the OdometerStart value. This element is used with Variable-Rate and Company Car configuration types. |
| OdometerStart | integer(int32) | false | none | The odometer reading at the start of the journey. This element is used with Variable-Rate and Company Car configuration types. |
| PersonalDistance | integer(int32) | false | none | The portion of the journey for personal use. This element is required in order to post a company car mileage expense when there is no BusinessDistance value. Format: positive integer. When using the Odometer elements, the sum of PersonalDistance and BusinessDistance must equal the difference between OdometerEnd and OdometerStart. Used with Company Car configuration types. |
| StartLocation | string | false | none | Indicates where the journey started. This is also known as the "From Location". Maximum length: 100 characters |
| UnitOfMeasure | string | false | none | The unit of measure for distance and odometer values. Supported values: M - miles, K - kilometers |
| VehicleID | string | false | none | The unique identifier for the vehicle used for this journey. This element is used only with Company Car configuration types. Use the GET Vehicles function to learn the Vehicle ID. |
Void
{}
Properties
None
Entry Attendee Associations v3.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Manage the relationship between the attendees and the expense report and entry, for the specified expense entry. This resource does not include the full attendee information, which can be accessed using the Attendees resource. This API provides methods to view, create, update, and delete entry attendee associations.
Base URLs:
Resources
get__expense_entryattendeeassociations
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /expense/entryattendeeassociations
Get all entry-attendee associations
Gets all entry-attendee associations owned by the user. These are the associations between an expense entry and an attendee.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| entryID | query | string | false | The ID of the entry for which to retrieve entry-attendee associations. |
| offset | query | string | false | The starting point of the next set of results, after the limit specified in the limit field has been reached. |
| limit | query | integer(int32) | false | The number of records to return. Default value: 25 |
| user | query | string | false | The login ID of the user who owns this entry-attendee association. The user must have the Web Services Admin role to use this parameter. |
Example responses
200 Response
{
"Items": {
"Amount": 0,
"AssociatedAttendeeCount": 0,
"AttendeeID": "string",
"Custom1": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"EntryID": "string",
"ID": "string",
"URI": "string"
},
"NextPage": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<EntryAttendeeAssociationCollection>
<Items>
<Amount>0</Amount>
<AssociatedAttendeeCount>0</AssociatedAttendeeCount>
<AttendeeID>string</AttendeeID>
<Custom1>string</Custom1>
<Custom2>string</Custom2>
<Custom3>string</Custom3>
<Custom4>string</Custom4>
<Custom5>string</Custom5>
<EntryID>string</EntryID>
<ID>string</ID>
<URI>string</URI>
</Items>
<NextPage>string</NextPage>
</EntryAttendeeAssociationCollection>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | EntryAttendeeAssociationCollection |
post__expense_entryattendeeassociations
Code samples
# You can also use wget
curl -X POST https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations HTTP/1.1
Host: www.concursolutions.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"Amount": 0,
"AssociatedAttendeeCount": 0,
"AttendeeID": "string",
"Custom1": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"EntryID": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /expense/entryattendeeassociations
Create entry-attendee association
Creates a new association between an expense entry and an attendee.
Body parameter
{
"Amount": 0,
"AssociatedAttendeeCount": 0,
"AttendeeID": "string",
"Custom1": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"EntryID": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<EntryAttendeeAssociationPost>
<Amount>0</Amount>
<AssociatedAttendeeCount>0</AssociatedAttendeeCount>
<AttendeeID>string</AttendeeID>
<Custom1>string</Custom1>
<Custom2>string</Custom2>
<Custom3>string</Custom3>
<Custom4>string</Custom4>
<Custom5>string</Custom5>
<EntryID>string</EntryID>
</EntryAttendeeAssociationPost>
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| user | query | string | false | The login ID of the user who owns this entry-attendee association. The user must have the Web Services Admin role to use this parameter. |
| body | body | EntryAttendeeAssociationPost | true | The EntryAttendeeAssociation object to create. |
Example responses
200 Response
{
"ID": "string",
"URI": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CreateResponse>
<ID>string</ID>
<URI>string</URI>
</CreateResponse>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | CreateResponse |
| 400 | Bad Request | Bad Request | Void |
get_expense_entryattendeeassociations{id}
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations/{id} HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /expense/entryattendeeassociations/{id}
Get a single entry-attendee association
Gets the specified entry-attendee association.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The ID of the entry-attendee association. |
| user | query | string | false | The login ID of the user who owns this entry-attendee association. The user must have the Web Services Admin role to use this parameter. |
Example responses
200 Response
{
"Amount": 0,
"AssociatedAttendeeCount": 0,
"AttendeeID": "string",
"Custom1": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"EntryID": "string",
"ID": "string",
"URI": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<EntryAttendeeAssociationGet>
<Amount>0</Amount>
<AssociatedAttendeeCount>0</AssociatedAttendeeCount>
<AttendeeID>string</AttendeeID>
<Custom1>string</Custom1>
<Custom2>string</Custom2>
<Custom3>string</Custom3>
<Custom4>string</Custom4>
<Custom5>string</Custom5>
<EntryID>string</EntryID>
<ID>string</ID>
<URI>string</URI>
</EntryAttendeeAssociationGet>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | EntryAttendeeAssociationGet |
put_expense_entryattendeeassociations{id}
Code samples
# You can also use wget
curl -X PUT https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
PUT https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations/{id} HTTP/1.1
Host: www.concursolutions.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"Amount": 0,
"AssociatedAttendeeCount": 0,
"Custom1": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put 'https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /expense/entryattendeeassociations/{id}
Update an entry-attendee association
Updates the specified entry-attendee association. Only the fields provided in the supplied object will be updated. Missing fields will not be altered.
Body parameter
{
"Amount": 0,
"AssociatedAttendeeCount": 0,
"Custom1": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<EntryAttendeeAssociationPut>
<Amount>0</Amount>
<AssociatedAttendeeCount>0</AssociatedAttendeeCount>
<Custom1>string</Custom1>
<Custom2>string</Custom2>
<Custom3>string</Custom3>
<Custom4>string</Custom4>
<Custom5>string</Custom5>
</EntryAttendeeAssociationPut>
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The ID of the entry-attendee association. |
| user | query | string | false | The login ID of the user who owns this entry-attendee association. The user must have the Web Services Admin role to use this parameter. |
| body | body | EntryAttendeeAssociationPut | true | The partial or complete EntryAttendeeAssociation object to update. |
Example responses
200 Response
{}
<?xml version="1.0" encoding="UTF-8" ?>
<Void/>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Void |
| 400 | Bad Request | Bad Request | Void |
delete_expense_entryattendeeassociations{id}
Code samples
# You can also use wget
curl -X DELETE https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
DELETE https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations/{id} HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /expense/entryattendeeassociations/{id}
Delete an entry-attendee association
Deletes the specified entry-attendee association.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The ID of the entry-attendee association to delete. |
| user | query | string | false | The login ID of the user who owns this entry-attendee association. The user must have the Web Services Admin role to use this parameter. |
Example responses
200 Response
{}
<?xml version="1.0" encoding="UTF-8" ?>
<Void/>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Void |
| 400 | Bad Request | Bad Request | Void |
Schemas
CreateResponse
{
"ID": "string",
"URI": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ID | string | false | none | none |
| URI | string | false | none | none |
EntryAttendeeAssociationCollection
{
"Items": {
"Amount": 0,
"AssociatedAttendeeCount": 0,
"AttendeeID": "string",
"Custom1": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"EntryID": "string",
"ID": "string",
"URI": "string"
},
"NextPage": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Items | EntryAttendeeAssociationGet | false | none | none |
| NextPage | string | false | none | The URI of the next page of results, if any. |
EntryAttendeeAssociationGet
{
"Amount": 0,
"AssociatedAttendeeCount": 0,
"AttendeeID": "string",
"Custom1": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"EntryID": "string",
"ID": "string",
"URI": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Amount | number(double) | false | none | The portion of the entry transaction amount assigned to this attendee. |
| AssociatedAttendeeCount | integer(int32) | false | none | The count of additional attendees associated with this attendee. A count greater than 1 means there are unnamed attendees associated with this attendee. |
| AttendeeID | string | false | none | The unique identifier of the associated attendee. To obtain the attendee ID value, use the "GET /expense/attendees" endpoint. |
| Custom1 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom2 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom3 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom4 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom5 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| EntryID | string | false | none | The unique identifier of the associated entry. To obtain the attendee ID value, use the "GET /expense/entries" endpoint. |
| ID | string | false | none | The unique identifier of the resource. |
| URI | string | false | none | The URI to the resource. |
EntryAttendeeAssociationPost
{
"Amount": 0,
"AssociatedAttendeeCount": 0,
"AttendeeID": "string",
"Custom1": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"EntryID": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Amount | number(double) | false | none | The portion of the entry transaction amount assigned to this attendee. |
| AssociatedAttendeeCount | integer(int32) | false | none | The count of additional attendees associated with this attendee. A count greater than 1 means there are unnamed attendees associated with this attendee. |
| AttendeeID | string | false | none | The unique identifier of the associated attendee. To obtain the attendee ID value, use the "GET /expense/attendees" endpoint. |
| Custom1 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom2 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom3 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom4 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom5 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| EntryID | string | false | none | The unique identifier of the associated entry. To obtain the attendee ID value, use the "GET /expense/entries" endpoint. The value of the ID element in the response is the entry ID. |
EntryAttendeeAssociationPut
{
"Amount": 0,
"AssociatedAttendeeCount": 0,
"Custom1": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Amount | number(double) | false | none | The portion of the entry transaction amount assigned to this attendee. |
| AssociatedAttendeeCount | integer(int32) | false | none | The count of additional attendees associated with this attendee. A count greater than 1 means there are unnamed attendees associated with this attendee. |
| Custom1 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom2 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom3 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom4 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
| Custom5 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. |
Void
{}
Properties
None
Expense Group Configurations v3.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Expense Group Configurations specify the allowed expense types, policies, payment types, and expense settings allowed for the expense group. This API provides methods to view the expense group details by user or by expense group ID.
Base URLs:
Resources
get__expense_expensegroupconfigurations
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/expense/expensegroupconfigurations \
-H 'Accept: application/json'
GET https://www.concursolutions.com/api/v3.0/expense/expensegroupconfigurations HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/expensegroupconfigurations',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/expense/expensegroupconfigurations',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/expense/expensegroupconfigurations', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/expense/expensegroupconfigurations', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/expensegroupconfigurations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/expense/expensegroupconfigurations", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /expense/expensegroupconfigurations
Get an expense group configuration
Gets the configuration of an expense group.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| user | query | string | false | The login ID of the user associated with this expense group configuration. The user must have the Web Services Admin role to use this parameter. |
| offset | query | string | false | The starting point of the next set of results, after the limit specified in the limit field has been reached. |
| limit | query | integer(int32) | false | The number of records to return Default value: 10 |
Example responses
200 Response
{
"Items": {
"AllowUserDigitalTaxInvoice": true,
"AllowUserRegisterYodlee": true,
"AttendeeListFormID": "string",
"AttendeeListFormName": "string",
"AttendeeTypes": {
"Code": "string",
"Name": "string"
},
"CashAdvance": {
"AllowUserCarryBalance": true,
"AllowUserLinkMultiple": true,
"AllowUserUpdateExchangeRate": true,
"Name": "string",
"WorkflowID": "string"
},
"ID": "string",
"Name": "string",
"PaymentTypes": {
"ID": "string",
"IsDefault": true,
"Name": "string"
},
"Policies": {
"ExpenseTypes": {
"Code": "string",
"ExpenseCode": "string",
"Name": "string"
},
"ID": "string",
"IsDefault": true,
"IsInheritable": true,
"Name": "string"
},
"URI": "string"
},
"NextPage": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ExpenseGroupConfigurationCollection>
<Items>
<AllowUserDigitalTaxInvoice>true</AllowUserDigitalTaxInvoice>
<AllowUserRegisterYodlee>true</AllowUserRegisterYodlee>
<AttendeeListFormID>string</AttendeeListFormID>
<AttendeeListFormName>string</AttendeeListFormName>
<AttendeeTypes>
<Code>string</Code>
<Name>string</Name>
</AttendeeTypes>
<CashAdvance>
<AllowUserCarryBalance>true</AllowUserCarryBalance>
<AllowUserLinkMultiple>true</AllowUserLinkMultiple>
<AllowUserUpdateExchangeRate>true</AllowUserUpdateExchangeRate>
<Name>string</Name>
<WorkflowID>string</WorkflowID>
</CashAdvance>
<ID>string</ID>
<Name>string</Name>
<PaymentTypes>
<ID>string</ID>
<IsDefault>true</IsDefault>
<Name>string</Name>
</PaymentTypes>
<Policies>
<ExpenseTypes>
<Code>string</Code>
<ExpenseCode>string</ExpenseCode>
<Name>string</Name>
</ExpenseTypes>
<ID>string</ID>
<IsDefault>true</IsDefault>
<IsInheritable>true</IsInheritable>
<Name>string</Name>
</Policies>
<URI>string</URI>
</Items>
<NextPage>string</NextPage>
</ExpenseGroupConfigurationCollection>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ExpenseGroupConfigurationCollection |
get_expense_expensegroupconfigurations{id}
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/expense/expensegroupconfigurations/{id} \
-H 'Accept: application/json'
GET https://www.concursolutions.com/api/v3.0/expense/expensegroupconfigurations/{id} HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/expensegroupconfigurations/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/expense/expensegroupconfigurations/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/expense/expensegroupconfigurations/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/expense/expensegroupconfigurations/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/expensegroupconfigurations/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/expense/expensegroupconfigurations/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /expense/expensegroupconfigurations/{id}
Get an expense group configuration by ID
Gets an expense group configuration by ID.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The ID of the expense group configuration. |
| user | query | string | false | The login ID of the user associated with this expense group configuration. The user must have the Web Services Admin role to use this parameter. |
Example responses
200 Response
{
"AllowUserDigitalTaxInvoice": true,
"AllowUserRegisterYodlee": true,
"AttendeeListFormID": "string",
"AttendeeListFormName": "string",
"AttendeeTypes": {
"Code": "string",
"Name": "string"
},
"CashAdvance": {
"AllowUserCarryBalance": true,
"AllowUserLinkMultiple": true,
"AllowUserUpdateExchangeRate": true,
"Name": "string",
"WorkflowID": "string"
},
"ID": "string",
"Name": "string",
"PaymentTypes": {
"ID": "string",
"IsDefault": true,
"Name": "string"
},
"Policies": {
"ExpenseTypes": {
"Code": "string",
"ExpenseCode": "string",
"Name": "string"
},
"ID": "string",
"IsDefault": true,
"IsInheritable": true,
"Name": "string"
},
"URI": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ExpenseGroupConfiguration>
<AllowUserDigitalTaxInvoice>true</AllowUserDigitalTaxInvoice>
<AllowUserRegisterYodlee>true</AllowUserRegisterYodlee>
<AttendeeListFormID>string</AttendeeListFormID>
<AttendeeListFormName>string</AttendeeListFormName>
<AttendeeTypes>
<Code>string</Code>
<Name>string</Name>
</AttendeeTypes>
<CashAdvance>
<AllowUserCarryBalance>true</AllowUserCarryBalance>
<AllowUserLinkMultiple>true</AllowUserLinkMultiple>
<AllowUserUpdateExchangeRate>true</AllowUserUpdateExchangeRate>
<Name>string</Name>
<WorkflowID>string</WorkflowID>
</CashAdvance>
<ID>string</ID>
<Name>string</Name>
<PaymentTypes>
<ID>string</ID>
<IsDefault>true</IsDefault>
<Name>string</Name>
</PaymentTypes>
<Policies>
<ExpenseTypes>
<Code>string</Code>
<ExpenseCode>string</ExpenseCode>
<Name>string</Name>
</ExpenseTypes>
<ID>string</ID>
<IsDefault>true</IsDefault>
<IsInheritable>true</IsInheritable>
<Name>string</Name>
</Policies>
<URI>string</URI>
</ExpenseGroupConfiguration>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ExpenseGroupConfiguration |
Schemas
AttendeeType
{
"Code": "string",
"Name": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Code | string | false | none | The attendee type code. |
| Name | string | false | none | The name of the attendee type. |
CashAdvance
{
"AllowUserCarryBalance": true,
"AllowUserLinkMultiple": true,
"AllowUserUpdateExchangeRate": true,
"Name": "string",
"WorkflowID": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| AllowUserCarryBalance | boolean | false | none | Indicates whether users are allowed to carry a cash advance balance forward from one report to another. Format: true or false |
| AllowUserLinkMultiple | boolean | false | none | Indicates whether users are allowed to link multiple cash advances to one expense report. Format: true or false |
| AllowUserUpdateExchangeRate | boolean | false | none | Indicates whether users are allowed to update the currency exchange rate for expense entries. Format: true or false |
| Name | string | false | none | The name of the cash advance workflow. |
| WorkflowID | string | false | none | The unique identifier for the cash advance workflow. Null means there is no such workflow. |
ExpenseGroupConfiguration
{
"AllowUserDigitalTaxInvoice": true,
"AllowUserRegisterYodlee": true,
"AttendeeListFormID": "string",
"AttendeeListFormName": "string",
"AttendeeTypes": {
"Code": "string",
"Name": "string"
},
"CashAdvance": {
"AllowUserCarryBalance": true,
"AllowUserLinkMultiple": true,
"AllowUserUpdateExchangeRate": true,
"Name": "string",
"WorkflowID": "string"
},
"ID": "string",
"Name": "string",
"PaymentTypes": {
"ID": "string",
"IsDefault": true,
"Name": "string"
},
"Policies": {
"ExpenseTypes": {
"Code": "string",
"ExpenseCode": "string",
"Name": "string"
},
"ID": "string",
"IsDefault": true,
"IsInheritable": true,
"Name": "string"
},
"URI": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| AllowUserDigitalTaxInvoice | boolean | false | none | Indicates whether users are allowed to upload digital tax invoices. Format: true or false |
| AllowUserRegisterYodlee | boolean | false | none | Indicates whether users in the expense group are allowed to register Yodlee credit cards. Format: true or false |
| AttendeeListFormID | string | false | none | The unique identifier for the attendee list form. |
| AttendeeListFormName | string | false | none | The name of the attendee list form. |
| AttendeeTypes | AttendeeType | false | none | none |
| CashAdvance | CashAdvance | false | none | none |
| ID | string | false | none | The unique identifier of the resource. |
| Name | string | false | none | The name of the expense group configuration. |
| PaymentTypes | PaymentType | false | none | none |
| Policies | Policy | false | none | none |
| URI | string | false | none | The URI to the resource. |
ExpenseGroupConfigurationCollection
{
"Items": {
"AllowUserDigitalTaxInvoice": true,
"AllowUserRegisterYodlee": true,
"AttendeeListFormID": "string",
"AttendeeListFormName": "string",
"AttendeeTypes": {
"Code": "string",
"Name": "string"
},
"CashAdvance": {
"AllowUserCarryBalance": true,
"AllowUserLinkMultiple": true,
"AllowUserUpdateExchangeRate": true,
"Name": "string",
"WorkflowID": "string"
},
"ID": "string",
"Name": "string",
"PaymentTypes": {
"ID": "string",
"IsDefault": true,
"Name": "string"
},
"Policies": {
"ExpenseTypes": {
"Code": "string",
"ExpenseCode": "string",
"Name": "string"
},
"ID": "string",
"IsDefault": true,
"IsInheritable": true,
"Name": "string"
},
"URI": "string"
},
"NextPage": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Items | ExpenseGroupConfiguration | false | none | none |
| NextPage | string | false | none | The URI of the next page of results, if any. |
ExpenseType
{
"Code": "string",
"ExpenseCode": "string",
"Name": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Code | string | false | none | The code for the expense type. Expense types define expenses within an expense category. For example, Business Meal is an expense type in the MEALS category. |
| ExpenseCode | string | false | none | The code for the expense category. The expense category code controls the function of an expense entry. Format: OTHER - Standard, COCARMILE - Company Car, PCARMILE - Personal Car, MFUEL - Fuel For Mileage, LODGING - Lodging, MEALS - Meals, OTHERNP - Other Not Partially Approvable, JPYPTRAN - Japanese Public Transportation |
| Name | string | false | none | The name of the expense type. |
PaymentType
{
"ID": "string",
"IsDefault": true,
"Name": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ID | string | false | none | The unique identifier of the resource. |
| IsDefault | boolean | false | none | Determines whether this payment type is the default. Format: true or false |
| Name | string | false | none | The name of the payment type. |
Policy
{
"ExpenseTypes": {
"Code": "string",
"ExpenseCode": "string",
"Name": "string"
},
"ID": "string",
"IsDefault": true,
"IsInheritable": true,
"Name": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ExpenseTypes | ExpenseType | false | none | none |
| ID | string | false | none | The unique identifier of the resource. |
| IsDefault | boolean | false | none | Indicates whether this policy is the default. Format: true or false |
| IsInheritable | boolean | false | none | Indicates whether the descendent nodes in the Expense Feature Hierarchy are covered by this policy. Format: true or false |
| Name | string | false | none | The name of the policy. |
Itemizations v3.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Expense Entry Itemizations are children of an expense entry that subdivide the expense. A common use case for itemizations is on a hotel bill, which can have separate itemizations for room rate, room tax, and services such as laundry or minibar.
Base URLs:
Resources
get__expense_itemizations
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/expense/itemizations \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://www.concursolutions.com/api/v3.0/expense/itemizations HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/itemizations',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/expense/itemizations',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/expense/itemizations', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/expense/itemizations', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/itemizations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/expense/itemizations", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /expense/itemizations
Get expense itemizations
Gets all expense itemizations owned by the user, with optional filtering parameters.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| reportID | query | string | false | The report ID of the itemizations to be retrieved. Format: An alpha-numeric string |
| entryID | query | string | false | The entry ID for the itemizations to be retrieved. |
| expenseTypeCode | query | string | false | The expense type code for the itemizations to be retrieved. |
| offset | query | string | false | The starting point of the next set of results, after the limit specified in the limit field has been reached. |
| limit | query | integer(int32) | false | The number of records to return. Default value: 25 |
| user | query | string | false | The login ID of the user who owns the itemizations. The user must have the Web Services Admin role to use this parameter. |
Example responses
200 Response
{
"Items": {
"AllocationType": "string",
"ApprovedAmount": 0,
"Custom1": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom2": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom3": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom4": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom5": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom6": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom7": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom8": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom9": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom10": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom11": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom12": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom13": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom14": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom15": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom16": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom17": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom18": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom19": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom20": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom21": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom22": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom23": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom24": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom25": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom26": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom27": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom28": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom29": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom30": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom37": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom38": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom39": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom40": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom41": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom42": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom43": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom44": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom45": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom46": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Description": "string",
"EntryID": "string",
"ExpenseTypeCode": "string",
"ExpenseTypeName": "string",
"HasComments": true,
"HasExceptions": true,
"ID": "string",
"IsBillable": true,
"IsImageRequired": true,
"IsPersonal": true,
"LastModified": "2019-08-24T14:15:22Z",
"LocationCountry": "string",
"LocationID": "string",
"LocationName": "string",
"LocationSubdivision": "string",
"OrgUnit1": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit2": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit3": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit4": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit5": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit6": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"PostedAmount": 0,
"ReportID": "string",
"ReportOwnerID": "string",
"SpendCategoryCode": "string",
"SpendCategoryName": "string",
"TransactionAmount": 0,
"TransactionDate": "2019-08-24T14:15:22Z",
"URI": "string"
},
"NextPage": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ItemizationCollection>
<Items>
<AllocationType>string</AllocationType>
<ApprovedAmount>0</ApprovedAmount>
<Custom1>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom1>
<Custom2>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom2>
<Custom3>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom3>
<Custom4>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom4>
<Custom5>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom5>
<Custom6>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom6>
<Custom7>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom7>
<Custom8>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom8>
<Custom9>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom9>
<Custom10>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom10>
<Custom11>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom11>
<Custom12>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom12>
<Custom13>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom13>
<Custom14>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom14>
<Custom15>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom15>
<Custom16>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom16>
<Custom17>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom17>
<Custom18>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom18>
<Custom19>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom19>
<Custom20>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom20>
<Custom21>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom21>
<Custom22>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom22>
<Custom23>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom23>
<Custom24>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom24>
<Custom25>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom25>
<Custom26>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom26>
<Custom27>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom27>
<Custom28>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom28>
<Custom29>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom29>
<Custom30>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom30>
<Custom37>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom37>
<Custom38>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom38>
<Custom39>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom39>
<Custom40>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom40>
<Custom41>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom41>
<Custom42>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom42>
<Custom43>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom43>
<Custom44>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom44>
<Custom45>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom45>
<Custom46>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom46>
<Description>string</Description>
<EntryID>string</EntryID>
<ExpenseTypeCode>string</ExpenseTypeCode>
<ExpenseTypeName>string</ExpenseTypeName>
<HasComments>true</HasComments>
<HasExceptions>true</HasExceptions>
<ID>string</ID>
<IsBillable>true</IsBillable>
<IsImageRequired>true</IsImageRequired>
<IsPersonal>true</IsPersonal>
<LastModified>2019-08-24T14:15:22Z</LastModified>
<LocationCountry>string</LocationCountry>
<LocationID>string</LocationID>
<LocationName>string</LocationName>
<LocationSubdivision>string</LocationSubdivision>
<OrgUnit1>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</OrgUnit1>
<OrgUnit2>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</OrgUnit2>
<OrgUnit3>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</OrgUnit3>
<OrgUnit4>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</OrgUnit4>
<OrgUnit5>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</OrgUnit5>
<OrgUnit6>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</OrgUnit6>
<PostedAmount>0</PostedAmount>
<ReportID>string</ReportID>
<ReportOwnerID>string</ReportOwnerID>
<SpendCategoryCode>string</SpendCategoryCode>
<SpendCategoryName>string</SpendCategoryName>
<TransactionAmount>0</TransactionAmount>
<TransactionDate>2019-08-24T14:15:22Z</TransactionDate>
<URI>string</URI>
</Items>
<NextPage>string</NextPage>
</ItemizationCollection>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ItemizationCollection |
post__expense_itemizations
Code samples
# You can also use wget
curl -X POST https://www.concursolutions.com/api/v3.0/expense/itemizations \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://www.concursolutions.com/api/v3.0/expense/itemizations HTTP/1.1
Host: www.concursolutions.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"Comment": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom21": "string",
"Custom22": "string",
"Custom23": "string",
"Custom24": "string",
"Custom25": "string",
"Custom26": "string",
"Custom27": "string",
"Custom28": "string",
"Custom29": "string",
"Custom3": "string",
"Custom30": "string",
"Custom31": "string",
"Custom32": "string",
"Custom33": "string",
"Custom34": "string",
"Custom35": "string",
"Custom36": "string",
"Custom37": "string",
"Custom38": "string",
"Custom39": "string",
"Custom4": "string",
"Custom40": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Description": "string",
"EntryID": "string",
"ExpenseTypeCode": "string",
"IsBillable": true,
"IsPersonal": true,
"OrgUnit1": "string",
"OrgUnit2": "string",
"OrgUnit3": "string",
"OrgUnit4": "string",
"OrgUnit5": "string",
"OrgUnit6": "string",
"TransactionAmount": 0,
"TransactionDate": "2019-08-24T14:15:22Z"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/itemizations',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://www.concursolutions.com/api/v3.0/expense/itemizations',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://www.concursolutions.com/api/v3.0/expense/itemizations', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://www.concursolutions.com/api/v3.0/expense/itemizations', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/itemizations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://www.concursolutions.com/api/v3.0/expense/itemizations", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /expense/itemizations
Create expense itemization
Creates a new expense itemization for the specified expense entry.
Body parameter
{
"Comment": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom21": "string",
"Custom22": "string",
"Custom23": "string",
"Custom24": "string",
"Custom25": "string",
"Custom26": "string",
"Custom27": "string",
"Custom28": "string",
"Custom29": "string",
"Custom3": "string",
"Custom30": "string",
"Custom31": "string",
"Custom32": "string",
"Custom33": "string",
"Custom34": "string",
"Custom35": "string",
"Custom36": "string",
"Custom37": "string",
"Custom38": "string",
"Custom39": "string",
"Custom4": "string",
"Custom40": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Description": "string",
"EntryID": "string",
"ExpenseTypeCode": "string",
"IsBillable": true,
"IsPersonal": true,
"OrgUnit1": "string",
"OrgUnit2": "string",
"OrgUnit3": "string",
"OrgUnit4": "string",
"OrgUnit5": "string",
"OrgUnit6": "string",
"TransactionAmount": 0,
"TransactionDate": "2019-08-24T14:15:22Z"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ItemizationPost>
<Comment>string</Comment>
<Custom1>string</Custom1>
<Custom10>string</Custom10>
<Custom11>string</Custom11>
<Custom12>string</Custom12>
<Custom13>string</Custom13>
<Custom14>string</Custom14>
<Custom15>string</Custom15>
<Custom16>string</Custom16>
<Custom17>string</Custom17>
<Custom18>string</Custom18>
<Custom19>string</Custom19>
<Custom2>string</Custom2>
<Custom20>string</Custom20>
<Custom21>string</Custom21>
<Custom22>string</Custom22>
<Custom23>string</Custom23>
<Custom24>string</Custom24>
<Custom25>string</Custom25>
<Custom26>string</Custom26>
<Custom27>string</Custom27>
<Custom28>string</Custom28>
<Custom29>string</Custom29>
<Custom3>string</Custom3>
<Custom30>string</Custom30>
<Custom31>string</Custom31>
<Custom32>string</Custom32>
<Custom33>string</Custom33>
<Custom34>string</Custom34>
<Custom35>string</Custom35>
<Custom36>string</Custom36>
<Custom37>string</Custom37>
<Custom38>string</Custom38>
<Custom39>string</Custom39>
<Custom4>string</Custom4>
<Custom40>string</Custom40>
<Custom5>string</Custom5>
<Custom6>string</Custom6>
<Custom7>string</Custom7>
<Custom8>string</Custom8>
<Custom9>string</Custom9>
<Description>string</Description>
<EntryID>string</EntryID>
<ExpenseTypeCode>string</ExpenseTypeCode>
<IsBillable>true</IsBillable>
<IsPersonal>true</IsPersonal>
<OrgUnit1>string</OrgUnit1>
<OrgUnit2>string</OrgUnit2>
<OrgUnit3>string</OrgUnit3>
<OrgUnit4>string</OrgUnit4>
<OrgUnit5>string</OrgUnit5>
<OrgUnit6>string</OrgUnit6>
<TransactionAmount>0</TransactionAmount>
<TransactionDate>2019-08-24T14:15:22Z</TransactionDate>
</ItemizationPost>
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| user | query | string | false | The login ID of the user who owns the itemizations. The user must have the Web Services Admin role to use this parameter. |
| body | body | ItemizationPost | true | The expense itemization object to create. |
Example responses
200 Response
{
"ID": "string",
"URI": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CreateResponse>
<ID>string</ID>
<URI>string</URI>
</CreateResponse>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | CreateResponse |
| 400 | Bad Request | Bad Request | Void |
get_expense_itemizations{id}
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/expense/itemizations/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://www.concursolutions.com/api/v3.0/expense/itemizations/{id} HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/itemizations/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/expense/itemizations/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/expense/itemizations/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/expense/itemizations/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/itemizations/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/expense/itemizations/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /expense/itemizations/{id}
Get a single expense itemization
Gets the specified expense itemization.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The ID of the expense itemization. |
| user | query | string | false | The login ID of the user who owns the itemizations. The user must have the Web Services Admin role to use this parameter. |
Example responses
200 Response
{
"AllocationType": "string",
"ApprovedAmount": 0,
"Custom1": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom2": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom3": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom4": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom5": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom6": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom7": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom8": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom9": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom10": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom11": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom12": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom13": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom14": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom15": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom16": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom17": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom18": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom19": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom20": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom21": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom22": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom23": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom24": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom25": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom26": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom27": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom28": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom29": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom30": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom37": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom38": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom39": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom40": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom41": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom42": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom43": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom44": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom45": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom46": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Description": "string",
"EntryID": "string",
"ExpenseTypeCode": "string",
"ExpenseTypeName": "string",
"HasComments": true,
"HasExceptions": true,
"ID": "string",
"IsBillable": true,
"IsImageRequired": true,
"IsPersonal": true,
"LastModified": "2019-08-24T14:15:22Z",
"LocationCountry": "string",
"LocationID": "string",
"LocationName": "string",
"LocationSubdivision": "string",
"OrgUnit1": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit2": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit3": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit4": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit5": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit6": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"PostedAmount": 0,
"ReportID": "string",
"ReportOwnerID": "string",
"SpendCategoryCode": "string",
"SpendCategoryName": "string",
"TransactionAmount": 0,
"TransactionDate": "2019-08-24T14:15:22Z",
"URI": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ItemizationGet>
<AllocationType>string</AllocationType>
<ApprovedAmount>0</ApprovedAmount>
<Custom1>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom1>
<Custom2>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom2>
<Custom3>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom3>
<Custom4>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom4>
<Custom5>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom5>
<Custom6>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom6>
<Custom7>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom7>
<Custom8>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom8>
<Custom9>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom9>
<Custom10>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom10>
<Custom11>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom11>
<Custom12>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom12>
<Custom13>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom13>
<Custom14>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom14>
<Custom15>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom15>
<Custom16>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom16>
<Custom17>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom17>
<Custom18>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom18>
<Custom19>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom19>
<Custom20>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom20>
<Custom21>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom21>
<Custom22>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom22>
<Custom23>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom23>
<Custom24>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom24>
<Custom25>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom25>
<Custom26>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom26>
<Custom27>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom27>
<Custom28>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom28>
<Custom29>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom29>
<Custom30>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom30>
<Custom37>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom37>
<Custom38>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom38>
<Custom39>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom39>
<Custom40>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom40>
<Custom41>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom41>
<Custom42>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom42>
<Custom43>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom43>
<Custom44>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom44>
<Custom45>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom45>
<Custom46>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom46>
<Description>string</Description>
<EntryID>string</EntryID>
<ExpenseTypeCode>string</ExpenseTypeCode>
<ExpenseTypeName>string</ExpenseTypeName>
<HasComments>true</HasComments>
<HasExceptions>true</HasExceptions>
<ID>string</ID>
<IsBillable>true</IsBillable>
<IsImageRequired>true</IsImageRequired>
<IsPersonal>true</IsPersonal>
<LastModified>2019-08-24T14:15:22Z</LastModified>
<LocationCountry>string</LocationCountry>
<LocationID>string</LocationID>
<LocationName>string</LocationName>
<LocationSubdivision>string</LocationSubdivision>
<OrgUnit1>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</OrgUnit1>
<OrgUnit2>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</OrgUnit2>
<OrgUnit3>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</OrgUnit3>
<OrgUnit4>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</OrgUnit4>
<OrgUnit5>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</OrgUnit5>
<OrgUnit6>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</OrgUnit6>
<PostedAmount>0</PostedAmount>
<ReportID>string</ReportID>
<ReportOwnerID>string</ReportOwnerID>
<SpendCategoryCode>string</SpendCategoryCode>
<SpendCategoryName>string</SpendCategoryName>
<TransactionAmount>0</TransactionAmount>
<TransactionDate>2019-08-24T14:15:22Z</TransactionDate>
<URI>string</URI>
</ItemizationGet>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ItemizationGet |
put_expense_itemizations{id}
Code samples
# You can also use wget
curl -X PUT https://www.concursolutions.com/api/v3.0/expense/itemizations/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
PUT https://www.concursolutions.com/api/v3.0/expense/itemizations/{id} HTTP/1.1
Host: www.concursolutions.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"Comment": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom21": "string",
"Custom22": "string",
"Custom23": "string",
"Custom24": "string",
"Custom25": "string",
"Custom26": "string",
"Custom27": "string",
"Custom28": "string",
"Custom29": "string",
"Custom3": "string",
"Custom30": "string",
"Custom31": "string",
"Custom32": "string",
"Custom33": "string",
"Custom34": "string",
"Custom35": "string",
"Custom36": "string",
"Custom37": "string",
"Custom38": "string",
"Custom39": "string",
"Custom4": "string",
"Custom40": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Description": "string",
"EntryID": "string",
"ExpenseTypeCode": "string",
"IsBillable": true,
"IsPersonal": true,
"OrgUnit1": "string",
"OrgUnit2": "string",
"OrgUnit3": "string",
"OrgUnit4": "string",
"OrgUnit5": "string",
"OrgUnit6": "string",
"TransactionAmount": 0,
"TransactionDate": "2019-08-24T14:15:22Z"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/itemizations/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put 'https://www.concursolutions.com/api/v3.0/expense/itemizations/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('https://www.concursolutions.com/api/v3.0/expense/itemizations/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','https://www.concursolutions.com/api/v3.0/expense/itemizations/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/itemizations/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://www.concursolutions.com/api/v3.0/expense/itemizations/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /expense/itemizations/{id}
Update an expense itemization
Updates the specified expense itemization. Only the fields provided in the supplied object are updated. Missing fields will not be altered.
Body parameter
{
"Comment": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom21": "string",
"Custom22": "string",
"Custom23": "string",
"Custom24": "string",
"Custom25": "string",
"Custom26": "string",
"Custom27": "string",
"Custom28": "string",
"Custom29": "string",
"Custom3": "string",
"Custom30": "string",
"Custom31": "string",
"Custom32": "string",
"Custom33": "string",
"Custom34": "string",
"Custom35": "string",
"Custom36": "string",
"Custom37": "string",
"Custom38": "string",
"Custom39": "string",
"Custom4": "string",
"Custom40": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Description": "string",
"EntryID": "string",
"ExpenseTypeCode": "string",
"IsBillable": true,
"IsPersonal": true,
"OrgUnit1": "string",
"OrgUnit2": "string",
"OrgUnit3": "string",
"OrgUnit4": "string",
"OrgUnit5": "string",
"OrgUnit6": "string",
"TransactionAmount": 0,
"TransactionDate": "2019-08-24T14:15:22Z"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ItemizationPut>
<Comment>string</Comment>
<Custom1>string</Custom1>
<Custom10>string</Custom10>
<Custom11>string</Custom11>
<Custom12>string</Custom12>
<Custom13>string</Custom13>
<Custom14>string</Custom14>
<Custom15>string</Custom15>
<Custom16>string</Custom16>
<Custom17>string</Custom17>
<Custom18>string</Custom18>
<Custom19>string</Custom19>
<Custom2>string</Custom2>
<Custom20>string</Custom20>
<Custom21>string</Custom21>
<Custom22>string</Custom22>
<Custom23>string</Custom23>
<Custom24>string</Custom24>
<Custom25>string</Custom25>
<Custom26>string</Custom26>
<Custom27>string</Custom27>
<Custom28>string</Custom28>
<Custom29>string</Custom29>
<Custom3>string</Custom3>
<Custom30>string</Custom30>
<Custom31>string</Custom31>
<Custom32>string</Custom32>
<Custom33>string</Custom33>
<Custom34>string</Custom34>
<Custom35>string</Custom35>
<Custom36>string</Custom36>
<Custom37>string</Custom37>
<Custom38>string</Custom38>
<Custom39>string</Custom39>
<Custom4>string</Custom4>
<Custom40>string</Custom40>
<Custom5>string</Custom5>
<Custom6>string</Custom6>
<Custom7>string</Custom7>
<Custom8>string</Custom8>
<Custom9>string</Custom9>
<Description>string</Description>
<EntryID>string</EntryID>
<ExpenseTypeCode>string</ExpenseTypeCode>
<IsBillable>true</IsBillable>
<IsPersonal>true</IsPersonal>
<OrgUnit1>string</OrgUnit1>
<OrgUnit2>string</OrgUnit2>
<OrgUnit3>string</OrgUnit3>
<OrgUnit4>string</OrgUnit4>
<OrgUnit5>string</OrgUnit5>
<OrgUnit6>string</OrgUnit6>
<TransactionAmount>0</TransactionAmount>
<TransactionDate>2019-08-24T14:15:22Z</TransactionDate>
</ItemizationPut>
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The ID of the expense itemization. |
| user | query | string | false | The login ID of the user who owns the itemizations. The user must have the Web Services Admin role to use this parameter. |
| body | body | ItemizationPut | true | The partial or complete expense itemization object to update. |
Example responses
200 Response
{}
<?xml version="1.0" encoding="UTF-8" ?>
<Void/>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Void |
| 400 | Bad Request | Bad Request | Void |
delete_expense_itemizations{id}
Code samples
# You can also use wget
curl -X DELETE https://www.concursolutions.com/api/v3.0/expense/itemizations/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
DELETE https://www.concursolutions.com/api/v3.0/expense/itemizations/{id} HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/itemizations/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://www.concursolutions.com/api/v3.0/expense/itemizations/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://www.concursolutions.com/api/v3.0/expense/itemizations/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','https://www.concursolutions.com/api/v3.0/expense/itemizations/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/itemizations/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://www.concursolutions.com/api/v3.0/expense/itemizations/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /expense/itemizations/{id}
Delete an expense itemization
Deletes the specified expense itemization.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The ID of the expense itemization to delete. |
| user | query | string | false | The login ID of the user who owns the itemizations. The user must have the Web Services Admin role to use this parameter. |
Example responses
200 Response
{}
<?xml version="1.0" encoding="UTF-8" ?>
<Void/>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Void |
| 400 | Bad Request | Bad Request | Void |
Schemas
CreateResponse
{
"ID": "string",
"URI": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ID | string | false | none | none |
| URI | string | false | none | none |
CustomField
{
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Code | string | false | none | For list fields, this is the list item code. |
| ListItemID | string | false | none | For list fields, this is the list item ID. |
| Type | string | false | none | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text |
| Value | string | false | none | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters |
ItemizationCollection
{
"Items": {
"AllocationType": "string",
"ApprovedAmount": 0,
"Custom1": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom2": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom3": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom4": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom5": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom6": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom7": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom8": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom9": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom10": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom11": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom12": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom13": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom14": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom15": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom16": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom17": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom18": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom19": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom20": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom21": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom22": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom23": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom24": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom25": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom26": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom27": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom28": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom29": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom30": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom37": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom38": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom39": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom40": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom41": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom42": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom43": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom44": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom45": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom46": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Description": "string",
"EntryID": "string",
"ExpenseTypeCode": "string",
"ExpenseTypeName": "string",
"HasComments": true,
"HasExceptions": true,
"ID": "string",
"IsBillable": true,
"IsImageRequired": true,
"IsPersonal": true,
"LastModified": "2019-08-24T14:15:22Z",
"LocationCountry": "string",
"LocationID": "string",
"LocationName": "string",
"LocationSubdivision": "string",
"OrgUnit1": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit2": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit3": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit4": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit5": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit6": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"PostedAmount": 0,
"ReportID": "string",
"ReportOwnerID": "string",
"SpendCategoryCode": "string",
"SpendCategoryName": "string",
"TransactionAmount": 0,
"TransactionDate": "2019-08-24T14:15:22Z",
"URI": "string"
},
"NextPage": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Items | ItemizationGet | false | none | none |
| NextPage | string | false | none | The URI of the next page of results, if any. |
ItemizationGet
{
"AllocationType": "string",
"ApprovedAmount": 0,
"Custom1": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom2": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom3": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom4": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom5": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom6": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom7": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom8": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom9": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom10": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom11": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom12": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom13": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom14": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom15": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom16": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom17": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom18": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom19": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom20": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom21": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom22": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom23": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom24": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom25": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom26": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom27": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom28": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom29": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom30": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom37": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom38": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom39": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom40": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom41": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom42": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom43": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom44": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom45": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom46": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Description": "string",
"EntryID": "string",
"ExpenseTypeCode": "string",
"ExpenseTypeName": "string",
"HasComments": true,
"HasExceptions": true,
"ID": "string",
"IsBillable": true,
"IsImageRequired": true,
"IsPersonal": true,
"LastModified": "2019-08-24T14:15:22Z",
"LocationCountry": "string",
"LocationID": "string",
"LocationName": "string",
"LocationSubdivision": "string",
"OrgUnit1": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit2": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit3": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit4": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit5": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit6": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"PostedAmount": 0,
"ReportID": "string",
"ReportOwnerID": "string",
"SpendCategoryCode": "string",
"SpendCategoryName": "string",
"TransactionAmount": 0,
"TransactionDate": "2019-08-24T14:15:22Z",
"URI": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| AllocationType | string | false | none | The type of allocation for the itemization. Supported values: P - partial allocation, F - full allocation, N - no allocation. |
| ApprovedAmount | number(double) | false | none | The approved amount of the expense itemization, in the report currency. |
| Custom1 | CustomField | false | none | none |
| Custom2 | CustomField | false | none | none |
| Custom3 | CustomField | false | none | none |
| Custom4 | CustomField | false | none | none |
| Custom5 | CustomField | false | none | none |
| Custom6 | CustomField | false | none | none |
| Custom7 | CustomField | false | none | none |
| Custom8 | CustomField | false | none | none |
| Custom9 | CustomField | false | none | none |
| Custom10 | CustomField | false | none | none |
| Custom11 | CustomField | false | none | none |
| Custom12 | CustomField | false | none | none |
| Custom13 | CustomField | false | none | none |
| Custom14 | CustomField | false | none | none |
| Custom15 | CustomField | false | none | none |
| Custom16 | CustomField | false | none | none |
| Custom17 | CustomField | false | none | none |
| Custom18 | CustomField | false | none | none |
| Custom19 | CustomField | false | none | none |
| Custom20 | CustomField | false | none | none |
| Custom21 | CustomField | false | none | none |
| Custom22 | CustomField | false | none | none |
| Custom23 | CustomField | false | none | none |
| Custom24 | CustomField | false | none | none |
| Custom25 | CustomField | false | none | none |
| Custom26 | CustomField | false | none | none |
| Custom27 | CustomField | false | none | none |
| Custom28 | CustomField | false | none | none |
| Custom29 | CustomField | false | none | none |
| Custom30 | CustomField | false | none | none |
| Custom37 | CustomField | false | none | none |
| Custom38 | CustomField | false | none | none |
| Custom39 | CustomField | false | none | none |
| Custom40 | CustomField | false | none | none |
| Custom41 | CustomField | false | none | none |
| Custom42 | CustomField | false | none | none |
| Custom43 | CustomField | false | none | none |
| Custom44 | CustomField | false | none | none |
| Custom45 | CustomField | false | none | none |
| Custom46 | CustomField | false | none | none |
| Description | string | false | none | The description of the expense. Maximum length: 64 characters |
| EntryID | string | false | none | The ID of the expense entry that is the parent for the itemization. |
| ExpenseTypeCode | string | false | none | The code for the expense type. Use the "GET ExpenseGroupConfigurations" endpoint to learn the expense type code for expense types that are active for this report's policy. |
| ExpenseTypeName | string | false | none | The name of the expense type, localized to the user's language. |
| HasComments | boolean | false | none | Indicates whether the expense has comments. Format: true or false |
| HasExceptions | boolean | false | none | Indicates whether the expense has exceptions. Format: true or false |
| ID | string | false | none | The unique identifier of the resource. |
| IsBillable | boolean | false | none | Indicates whether the itemization is billable. Format: true or false |
| IsImageRequired | boolean | false | none | Indicates whether a receipt image is required for the entry. Format: true or false |
| IsPersonal | boolean | false | none | Indicates whether the itemization is personal (that is, non-reimbursable). Format: true or false |
| LastModified | string(date-time) | false | none | The UTC date when the itemization was last modified. |
| LocationCountry | string | false | none | The country where the expense was incurred. Format: 2-letter ISO 3166-1 country code |
| LocationID | string | false | none | The unique identifier for the location where the expense was incurred. |
| LocationName | string | false | none | The location where the expense was incurred, usually the city name. |
| LocationSubdivision | string | false | none | The state, province, or other country subdivision where the expense was incurred. Format: ISO 3166-2:2007 country subdivision |
| OrgUnit1 | CustomField | false | none | none |
| OrgUnit2 | CustomField | false | none | none |
| OrgUnit3 | CustomField | false | none | none |
| OrgUnit4 | CustomField | false | none | none |
| OrgUnit5 | CustomField | false | none | none |
| OrgUnit6 | CustomField | false | none | none |
| PostedAmount | number(double) | false | none | The amount of the expense itemization, in the report currency. |
| ReportID | string | false | none | The ID of the report that is the parent for the itemization. |
| ReportOwnerID | string | false | none | The login ID for the report owner. |
| SpendCategoryCode | string | false | none | The code for the spending category that is specified for this itemization. |
| SpendCategoryName | string | false | none | The name of the spending category that is specified for this itemization, localized to the user's language. |
| TransactionAmount | number(double) | false | none | The amount of the expense itemization, in the transaction currency of the parent expense entry. |
| TransactionDate | string(date-time) | false | none | The date when the good or service associated with this itemization was provided. Format: YYYY-MM-DD |
| URI | string | false | none | The URI to the resource. |
ItemizationPost
{
"Comment": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom21": "string",
"Custom22": "string",
"Custom23": "string",
"Custom24": "string",
"Custom25": "string",
"Custom26": "string",
"Custom27": "string",
"Custom28": "string",
"Custom29": "string",
"Custom3": "string",
"Custom30": "string",
"Custom31": "string",
"Custom32": "string",
"Custom33": "string",
"Custom34": "string",
"Custom35": "string",
"Custom36": "string",
"Custom37": "string",
"Custom38": "string",
"Custom39": "string",
"Custom4": "string",
"Custom40": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Description": "string",
"EntryID": "string",
"ExpenseTypeCode": "string",
"IsBillable": true,
"IsPersonal": true,
"OrgUnit1": "string",
"OrgUnit2": "string",
"OrgUnit3": "string",
"OrgUnit4": "string",
"OrgUnit5": "string",
"OrgUnit6": "string",
"TransactionAmount": 0,
"TransactionDate": "2019-08-24T14:15:22Z"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Comment | string | false | none | The expense itemization comment. Maximum length: 500 characters |
| Custom1 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom10 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom11 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom12 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom13 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom14 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom15 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom16 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom17 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom18 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom19 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom2 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom20 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom21 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom22 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom23 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom24 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom25 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom26 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom27 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom28 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom29 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom3 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom30 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom31 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom32 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom33 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom34 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom35 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom36 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom37 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom38 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom39 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom4 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom40 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom5 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom6 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom7 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom8 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom9 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Description | string | false | none | The description of the expense. Maximum length: 64 characters |
| EntryID | string | false | none | The ID of the expense entry that is the parent for the itemization. Use the "GET Entries" endpoint to learn the entry ID for the expense itemizations. |
| ExpenseTypeCode | string | false | none | The code for the expense type. Use the "GET Expense Group Configurations" endpoint to learn the expense type code for expense types that are active for this report's policy. |
| IsBillable | boolean | false | none | Indicates whether the itemization is billable. Format: true or false |
| IsPersonal | boolean | false | none | Indicates whether the itemization is personal (that is, non-reimbursable). Format: true or false |
| OrgUnit1 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| OrgUnit2 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| OrgUnit3 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| OrgUnit4 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| OrgUnit5 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| OrgUnit6 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| TransactionAmount | number(double) | false | none | The amount of the expense itemization, in the transaction currency of the parent expense entry. |
| TransactionDate | string(date-time) | false | none | The date when the good or service associated with this itemization was provided. Format: YYYY-MM-DD |
ItemizationPut
{
"Comment": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom21": "string",
"Custom22": "string",
"Custom23": "string",
"Custom24": "string",
"Custom25": "string",
"Custom26": "string",
"Custom27": "string",
"Custom28": "string",
"Custom29": "string",
"Custom3": "string",
"Custom30": "string",
"Custom31": "string",
"Custom32": "string",
"Custom33": "string",
"Custom34": "string",
"Custom35": "string",
"Custom36": "string",
"Custom37": "string",
"Custom38": "string",
"Custom39": "string",
"Custom4": "string",
"Custom40": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Description": "string",
"EntryID": "string",
"ExpenseTypeCode": "string",
"IsBillable": true,
"IsPersonal": true,
"OrgUnit1": "string",
"OrgUnit2": "string",
"OrgUnit3": "string",
"OrgUnit4": "string",
"OrgUnit5": "string",
"OrgUnit6": "string",
"TransactionAmount": 0,
"TransactionDate": "2019-08-24T14:15:22Z"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Comment | string | false | none | The expense itemization comment. Maximum length: 500 characters |
| Custom1 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom10 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom11 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom12 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom13 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom14 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom15 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom16 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom17 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom18 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom19 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom2 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom20 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom21 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom22 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom23 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom24 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom25 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom26 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom27 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom28 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom29 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom3 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom30 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom31 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom32 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom33 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom34 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom35 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom36 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom37 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom38 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom39 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom4 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom40 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom5 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom6 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom7 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom8 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Custom9 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| Description | string | false | none | The description of the expense. Maximum length: 64 characters |
| EntryID | string | false | none | The ID of the expense entry that is the parent for the itemization. Use the "GET Entries" endpoint to learn the entry ID for the expense itemizations. |
| ExpenseTypeCode | string | false | none | The code for the expense type. Use the "GET Expense Group Configurations" endpoint to learn the expense type code for expense types that are active for this report's policy. |
| IsBillable | boolean | false | none | Indicates whether the itemization is billable. Format: true or false |
| IsPersonal | boolean | false | none | Indicates whether the itemization is personal (that is, non-reimbursable). Format: true or false |
| OrgUnit1 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| OrgUnit2 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| OrgUnit3 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| OrgUnit4 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| OrgUnit5 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| OrgUnit6 | string | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration. Maximum length: 64 characters |
| TransactionAmount | number(double) | false | none | The amount of the expense itemization, in the transaction currency of the parent expense entry. |
| TransactionDate | string(date-time) | false | none | The date when the good or service associated with this itemization was provided. Format: YYYY-MM-DD |
Void
{}
Properties
None
Latest Bookings v3.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Base URLs:
Resources
get_insights_latestbookings
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/insights/latestbookings/ \
-H 'Accept: application/json'
GET https://www.concursolutions.com/api/v3.0/insights/latestbookings/ HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://www.concursolutions.com/api/v3.0/insights/latestbookings/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/insights/latestbookings/',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/insights/latestbookings/', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/insights/latestbookings/', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/insights/latestbookings/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/insights/latestbookings/", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /insights/latestbookings/
Get the latest hotel and air booking for a particular user.
Get the latest hotel and air booking for a particular user.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| user | query | string | false | Optional. The login ID of the user. The user must have the Web Services Admin (Professional) or Can Administer (Standard) user role to use this parameter. |
Example responses
200 Response
{
"Airlines": {
"BookingClass": "string",
"Code": "string"
},
"Hotel": {
"Location": "string",
"StarRating": 0
}
}
<?xml version="1.0" encoding="UTF-8" ?>
<LatestBooking>
<Airlines>
<BookingClass>string</BookingClass>
<Code>string</Code>
</Airlines>
<Hotel>
<Location>string</Location>
<StarRating>0</StarRating>
</Hotel>
</LatestBooking>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | LatestBooking |
Schemas
Airline
{
"BookingClass": "string",
"Code": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| BookingClass | string | false | none | The booking class of the latest booked airline segment. |
| Code | string | false | none | The airline code of the latest booked airline segment. |
Hotel
{
"Location": "string",
"StarRating": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Location | string | false | none | The IATA airport code of the location of the latest booked hotel segment. |
| StarRating | integer(int32) | false | none | The star rating of the latest booked hotel segment. Possible values are from 0 - 5. Values 1 - 5 are mapped to the Northstar standard. If the value is 0, the star rating could not be found. |
LatestBooking
{
"Airlines": {
"BookingClass": "string",
"Code": "string"
},
"Hotel": {
"Location": "string",
"StarRating": 0
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Airlines | Airline | false | none | none |
| Hotel | Hotel | false | none | none |
List Items v3.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Provides an automated solution to clients who would like to manage list items. This API provides methods to view, add, update or delete list items owned by the specified lists. This API supports Concur Expense, Concur Invoice, and Concur Request.
Base URLs:
Resources
get__common_listitems
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/common/listitems \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://www.concursolutions.com/api/v3.0/common/listitems HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/common/listitems',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/common/listitems',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/common/listitems', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/common/listitems', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/common/listitems");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/common/listitems", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /common/listitems
Get all list items
Returns all list items based on the search criteria.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| limit | query | integer(int32) | false | The number of records to return. The default is 25 and the maximum is 100. |
| offset | query | string | false | The start of the page offset. The default is from the beginning. |
| listId | query | string | false | The unique identifier for the list this item is a member of. |
| name | query | string | false | The name of the list item. Maximum length: 64. |
| parentId | query | string | false | The unique identifier of this item's parent. Empty when there is no parent. |
| level1Code | query | string | false | The item code for the first level of the list. All lists have at least a Level1Code. Maximum 32 characters |
| level2Code | query | string | false | The item code for the second level of the list. Empty when this level doesn't exist in the list. Maximum 32 characters |
| level3Code | query | string | false | The item code for the third level of the list. Empty when this level doesn't exist in the list. Maximum 32 characters |
| level4Code | query | string | false | The item code for the fourth level of the list. Empty when this level doesn't exist in the list. Maximum 32 characters |
| level5Code | query | string | false | The item code for the fifth level of the list. Empty when this level doesn't exist in the list. Maximum 32 characters |
| level6Code | query | string | false | The item code for the sixth level of the list. Empty when this level doesn't exist in the list. Maximum 32 characters |
| level7Code | query | string | false | The item code for the seventh level of the list. Empty when this level doesn't exist in the list. Maximum 32 characters |
| level8Code | query | string | false | The item code for the eighth level of the list. Empty when this level doesn't exist in the list. Maximum 32 characters |
| level9Code | query | string | false | The item code for the ninth level of the list. Empty when this level doesn't exist in the list. Maximum 32 characters |
| level10Code | query | string | false | The item code for the tenth level of the list. Empty when this level doesn't exist in the list. Maximum 32 characters |
Example responses
200 Response
{
"Items": {
"ID": "string",
"Level10Code": "string",
"Level1Code": "string",
"Level2Code": "string",
"Level3Code": "string",
"Level4Code": "string",
"Level5Code": "string",
"Level6Code": "string",
"Level7Code": "string",
"Level8Code": "string",
"Level9Code": "string",
"ListID": "string",
"Name": "string",
"ParentID": "string",
"URI": "string"
},
"NextPage": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ListItemGetCollection>
<Items>
<ID>string</ID>
<Level10Code>string</Level10Code>
<Level1Code>string</Level1Code>
<Level2Code>string</Level2Code>
<Level3Code>string</Level3Code>
<Level4Code>string</Level4Code>
<Level5Code>string</Level5Code>
<Level6Code>string</Level6Code>
<Level7Code>string</Level7Code>
<Level8Code>string</Level8Code>
<Level9Code>string</Level9Code>
<ListID>string</ListID>
<Name>string</Name>
<ParentID>string</ParentID>
<URI>string</URI>
</Items>
<NextPage>string</NextPage>
</ListItemGetCollection>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ListItemGetCollection |
post__common_listitems
Code samples
# You can also use wget
curl -X POST https://www.concursolutions.com/api/v3.0/common/listitems \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://www.concursolutions.com/api/v3.0/common/listitems HTTP/1.1
Host: www.concursolutions.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"Level10Code": "string",
"Level1Code": "string",
"Level2Code": "string",
"Level3Code": "string",
"Level4Code": "string",
"Level5Code": "string",
"Level6Code": "string",
"Level7Code": "string",
"Level8Code": "string",
"Level9Code": "string",
"ListID": "string",
"Name": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/common/listitems',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://www.concursolutions.com/api/v3.0/common/listitems',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://www.concursolutions.com/api/v3.0/common/listitems', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://www.concursolutions.com/api/v3.0/common/listitems', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/common/listitems");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://www.concursolutions.com/api/v3.0/common/listitems", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /common/listitems
Create a new list item
Creates a new item in the specified list.
Body parameter
{
"Level10Code": "string",
"Level1Code": "string",
"Level2Code": "string",
"Level3Code": "string",
"Level4Code": "string",
"Level5Code": "string",
"Level6Code": "string",
"Level7Code": "string",
"Level8Code": "string",
"Level9Code": "string",
"ListID": "string",
"Name": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ListItemPost>
<Level10Code>string</Level10Code>
<Level1Code>string</Level1Code>
<Level2Code>string</Level2Code>
<Level3Code>string</Level3Code>
<Level4Code>string</Level4Code>
<Level5Code>string</Level5Code>
<Level6Code>string</Level6Code>
<Level7Code>string</Level7Code>
<Level8Code>string</Level8Code>
<Level9Code>string</Level9Code>
<ListID>string</ListID>
<Name>string</Name>
</ListItemPost>
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | ListItemPost | true | List item object to create. |
Example responses
200 Response
{
"ID": "string",
"URI": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CreateResponse>
<ID>string</ID>
<URI>string</URI>
</CreateResponse>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | CreateResponse |
| 400 | Bad Request | Bad Request | Void |
get_common_listitems{id}
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/common/listitems/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://www.concursolutions.com/api/v3.0/common/listitems/{id} HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/common/listitems/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/common/listitems/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/common/listitems/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/common/listitems/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/common/listitems/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/common/listitems/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /common/listitems/{id}
Get a single list item by ID
Returns the specified list item.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The unique identifier for the list item. |
| listId | query | string | false | The unique identifier for the list this item is a member. |
Example responses
200 Response
{
"ID": "string",
"Level10Code": "string",
"Level1Code": "string",
"Level2Code": "string",
"Level3Code": "string",
"Level4Code": "string",
"Level5Code": "string",
"Level6Code": "string",
"Level7Code": "string",
"Level8Code": "string",
"Level9Code": "string",
"ListID": "string",
"Name": "string",
"ParentID": "string",
"URI": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ListItemGet>
<ID>string</ID>
<Level10Code>string</Level10Code>
<Level1Code>string</Level1Code>
<Level2Code>string</Level2Code>
<Level3Code>string</Level3Code>
<Level4Code>string</Level4Code>
<Level5Code>string</Level5Code>
<Level6Code>string</Level6Code>
<Level7Code>string</Level7Code>
<Level8Code>string</Level8Code>
<Level9Code>string</Level9Code>
<ListID>string</ListID>
<Name>string</Name>
<ParentID>string</ParentID>
<URI>string</URI>
</ListItemGet>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ListItemGet |
put_common_listitems{id}
Code samples
# You can also use wget
curl -X PUT https://www.concursolutions.com/api/v3.0/common/listitems/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
PUT https://www.concursolutions.com/api/v3.0/common/listitems/{id} HTTP/1.1
Host: www.concursolutions.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"Code": "string",
"ListID": "string",
"Name": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/common/listitems/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put 'https://www.concursolutions.com/api/v3.0/common/listitems/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('https://www.concursolutions.com/api/v3.0/common/listitems/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','https://www.concursolutions.com/api/v3.0/common/listitems/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/common/listitems/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://www.concursolutions.com/api/v3.0/common/listitems/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /common/listitems/{id}
Update list item
Updates the specified list item. Only the provided fields will be updated, missing fields will not be altered.
Body parameter
{
"Code": "string",
"ListID": "string",
"Name": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ListItemPut>
<Code>string</Code>
<ListID>string</ListID>
<Name>string</Name>
</ListItemPut>
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The unique identifier for the list item. |
| body | body | ListItemPut | true | The list item object to update |
Example responses
200 Response
{}
<?xml version="1.0" encoding="UTF-8" ?>
<Void/>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Void |
| 400 | Bad Request | Bad Request | Void |
delete_common_listitems{id}
Code samples
# You can also use wget
curl -X DELETE https://www.concursolutions.com/api/v3.0/common/listitems/{id}?listId=string \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
DELETE https://www.concursolutions.com/api/v3.0/common/listitems/{id}?listId=string HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/common/listitems/{id}?listId=string',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://www.concursolutions.com/api/v3.0/common/listitems/{id}',
params: {
'listId' => 'string'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://www.concursolutions.com/api/v3.0/common/listitems/{id}', params={
'listId': 'string'
}, headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','https://www.concursolutions.com/api/v3.0/common/listitems/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/common/listitems/{id}?listId=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://www.concursolutions.com/api/v3.0/common/listitems/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /common/listitems/{id}
Delete list item by ID
Deletes the specified list item.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The unique identifier of the list item to delete |
| listId | query | string | true | The unique identifier of the list associated with a list item to be deleted |
Example responses
200 Response
{}
<?xml version="1.0" encoding="UTF-8" ?>
<Void/>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Void |
| 400 | Bad Request | Bad Request | Void |
Schemas
CreateResponse
{
"ID": "string",
"URI": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ID | string | false | none | none |
| URI | string | false | none | none |
ListItemGet
{
"ID": "string",
"Level10Code": "string",
"Level1Code": "string",
"Level2Code": "string",
"Level3Code": "string",
"Level4Code": "string",
"Level5Code": "string",
"Level6Code": "string",
"Level7Code": "string",
"Level8Code": "string",
"Level9Code": "string",
"ListID": "string",
"Name": "string",
"ParentID": "string",
"URI": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ID | string | false | none | The unique identifier of the resource. |
| Level10Code | string | false | none | The item code for the tenth level of the list. Empty when this level doesn't exist in the list. Maximum 32 characters |
| Level1Code | string | false | none | The item code for the first level of the list. All lists have at least a Level1Code. Maximum 32 characters |
| Level2Code | string | false | none | The item code for the second level of the list. Empty when this level doesn't exist in the list. Maximum 32 characters |
| Level3Code | string | false | none | The item code for the third level of the list. Empty when this level doesn't exist in the list. Maximum 32 characters |
| Level4Code | string | false | none | The item code for the fourth level of the list. Empty when this level doesn't exist in the list. Maximum 32 characters |
| Level5Code | string | false | none | The item code for the fifth level of the list. Empty when this level doesn't exist in the list. Maximum 32 characters |
| Level6Code | string | false | none | The item code for the sixth level of the list. Empty when this level doesn't exist in the list. Maximum 32 characters |
| Level7Code | string | false | none | The item code for the seventh level of the list. Empty when this level doesn't exist in the list. Maximum 32 characters |
| Level8Code | string | false | none | The item code for the eighth level of the list. Empty when this level doesn't exist in the list. Maximum 32 characters |
| Level9Code | string | false | none | The item code for the ninth level of the list. Empty when this level doesn't exist in the list. Maximum 32 characters |
| ListID | string | false | none | The unique identifier for the list this item is a member of. |
| Name | string | false | none | The name of item. Maximum 64 characters |
| ParentID | string | false | none | The unique identifier of this item's parent. Empty when there is no parent. |
| URI | string | false | none | The URI to the resource. |
ListItemGetCollection
{
"Items": {
"ID": "string",
"Level10Code": "string",
"Level1Code": "string",
"Level2Code": "string",
"Level3Code": "string",
"Level4Code": "string",
"Level5Code": "string",
"Level6Code": "string",
"Level7Code": "string",
"Level8Code": "string",
"Level9Code": "string",
"ListID": "string",
"Name": "string",
"ParentID": "string",
"URI": "string"
},
"NextPage": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Items | ListItemGet | false | none | none |
| NextPage | string | false | none | The URI of the next page of results, if any. |
ListItemPost
{
"Level10Code": "string",
"Level1Code": "string",
"Level2Code": "string",
"Level3Code": "string",
"Level4Code": "string",
"Level5Code": "string",
"Level6Code": "string",
"Level7Code": "string",
"Level8Code": "string",
"Level9Code": "string",
"ListID": "string",
"Name": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Level10Code | string | false | none | The item code for the tenth level of the list. Empty when this level doesn't exist in the list. Maximum 32 characters |
| Level1Code | string | false | none | The item code for the first level of the list. All lists have at least a Level1Code. Maximum 32 characters |
| Level2Code | string | false | none | The item code for the second level of the list. Empty when this level doesn't exist in the list. Maximum 32 characters |
| Level3Code | string | false | none | The item code for the third level of the list. Empty when this level doesn't exist in the list. Maximum 32 characters |
| Level4Code | string | false | none | The item code for the fourth level of the list. Empty when this level doesn't exist in the list. Maximum 32 characters |
| Level5Code | string | false | none | The item code for the fifth level of the list. Empty when this level doesn't exist in the list. Maximum 32 characters |
| Level6Code | string | false | none | The item code for the sixth level of the list. Empty when this level doesn't exist in the list. Maximum 32 characters |
| Level7Code | string | false | none | The item code for the seventh level of the list. Empty when this level doesn't exist in the list. Maximum 32 characters |
| Level8Code | string | false | none | The item code for the eighth level of the list. Empty when this level doesn't exist in the list. Maximum 32 characters |
| Level9Code | string | false | none | The item code for the ninth level of the list. Empty when this level doesn't exist in the list. Maximum 32 characters |
| ListID | string | false | none | The unique identifier for the list this item is a member of. |
| Name | string | false | none | The name of item. Maximum 64 characters |
ListItemPut
{
"Code": "string",
"ListID": "string",
"Name": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Code | string | false | none | The item code of the list item. Maximum 32 characters |
| ListID | string | false | none | The unique identifier for the list this item is a member of. |
| Name | string | false | none | The name of item. Maximum 64 characters |
Void
{}
Properties
None
Lists v3.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Base URLs:
Resources
get__common_lists
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/common/lists \
-H 'Accept: application/json'
GET https://www.concursolutions.com/api/v3.0/common/lists HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://www.concursolutions.com/api/v3.0/common/lists',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/common/lists',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/common/lists', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/common/lists', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/common/lists");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/common/lists", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /common/lists
Gets all lists
Returns all lists based on the search criteria.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| limit | query | integer(int32) | false | The number of records to return. The default is 25 and the maximum is 100. |
| offset | query | string | false | The start of the page offset. The default is from the beginning. |
Example responses
200 Response
{
"Items": {
"ConnectorID": "string",
"DisplayCodeFirst": true,
"ExternalThreshold": 0,
"ID": "string",
"IsVendorList": true,
"Name": "string",
"SearchCriteriaCode": "string",
"URI": "string"
},
"NextPage": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ListGetCollection>
<Items>
<ConnectorID>string</ConnectorID>
<DisplayCodeFirst>true</DisplayCodeFirst>
<ExternalThreshold>0</ExternalThreshold>
<ID>string</ID>
<IsVendorList>true</IsVendorList>
<Name>string</Name>
<SearchCriteriaCode>string</SearchCriteriaCode>
<URI>string</URI>
</Items>
<NextPage>string</NextPage>
</ListGetCollection>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ListGetCollection |
post__common_lists
Code samples
# You can also use wget
curl -X POST https://www.concursolutions.com/api/v3.0/common/lists \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
POST https://www.concursolutions.com/api/v3.0/common/lists HTTP/1.1
Host: www.concursolutions.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"ConnectorID": "string",
"DisplayCodeFirst": true,
"ExternalThreshold": 0,
"IsVendorList": true,
"Name": "string",
"SearchCriteriaCode": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://www.concursolutions.com/api/v3.0/common/lists',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://www.concursolutions.com/api/v3.0/common/lists',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://www.concursolutions.com/api/v3.0/common/lists', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://www.concursolutions.com/api/v3.0/common/lists', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/common/lists");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://www.concursolutions.com/api/v3.0/common/lists", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /common/lists
Create a new list
Create a new list
Body parameter
{
"ConnectorID": "string",
"DisplayCodeFirst": true,
"ExternalThreshold": 0,
"IsVendorList": true,
"Name": "string",
"SearchCriteriaCode": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ListPost>
<ConnectorID>string</ConnectorID>
<DisplayCodeFirst>true</DisplayCodeFirst>
<ExternalThreshold>0</ExternalThreshold>
<IsVendorList>true</IsVendorList>
<Name>string</Name>
<SearchCriteriaCode>string</SearchCriteriaCode>
</ListPost>
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | ListPost | true | list object to create |
Example responses
200 Response
{
"ID": "string",
"URI": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CreateResponse>
<ID>string</ID>
<URI>string</URI>
</CreateResponse>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | CreateResponse |
get_common_lists{id}
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/common/lists/{id} \
-H 'Accept: application/json'
GET https://www.concursolutions.com/api/v3.0/common/lists/{id} HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://www.concursolutions.com/api/v3.0/common/lists/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/common/lists/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/common/lists/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/common/lists/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/common/lists/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/common/lists/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /common/lists/{id}
Get a single list by ID
Returns a list by ID.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The unique identifier for the list. |
Example responses
200 Response
{
"ConnectorID": "string",
"DisplayCodeFirst": true,
"ExternalThreshold": 0,
"ID": "string",
"IsVendorList": true,
"Name": "string",
"SearchCriteriaCode": "string",
"URI": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ListGet>
<ConnectorID>string</ConnectorID>
<DisplayCodeFirst>true</DisplayCodeFirst>
<ExternalThreshold>0</ExternalThreshold>
<ID>string</ID>
<IsVendorList>true</IsVendorList>
<Name>string</Name>
<SearchCriteriaCode>string</SearchCriteriaCode>
<URI>string</URI>
</ListGet>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ListGet |
put_common_lists{id}
Code samples
# You can also use wget
curl -X PUT https://www.concursolutions.com/api/v3.0/common/lists/{id} \
-H 'Content-Type: application/json'
PUT https://www.concursolutions.com/api/v3.0/common/lists/{id} HTTP/1.1
Host: www.concursolutions.com
Content-Type: application/json
const inputBody = '{
"DisplayCodeFirst": true,
"Name": "string",
"SearchCriteriaCode": "string"
}';
const headers = {
'Content-Type':'application/json'
};
fetch('https://www.concursolutions.com/api/v3.0/common/lists/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json'
}
result = RestClient.put 'https://www.concursolutions.com/api/v3.0/common/lists/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json'
}
r = requests.put('https://www.concursolutions.com/api/v3.0/common/lists/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','https://www.concursolutions.com/api/v3.0/common/lists/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/common/lists/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://www.concursolutions.com/api/v3.0/common/lists/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /common/lists/{id}
Update list
DEPRECATED: 05/19/2016 UNSUPPORTED: 11/19/2016. Updates list specified in the URL. Only the fields provided in the supplied object will be updated, missing fields will not be altered.
Body parameter
{
"DisplayCodeFirst": true,
"Name": "string",
"SearchCriteriaCode": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ListPut>
<DisplayCodeFirst>true</DisplayCodeFirst>
<Name>string</Name>
<SearchCriteriaCode>string</SearchCriteriaCode>
</ListPut>
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The unique identifier for the list. |
| body | body | ListPut | true | The list object to update |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
Schemas
CreateResponse
{
"ID": "string",
"URI": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ID | string | false | none | none |
| URI | string | false | none | none |
ListGet
{
"ConnectorID": "string",
"DisplayCodeFirst": true,
"ExternalThreshold": 0,
"ID": "string",
"IsVendorList": true,
"Name": "string",
"SearchCriteriaCode": "string",
"URI": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ConnectorID | string | false | none | Optional. Defines the encrypted ConnectorID. If not provided then the list isn't associated with a connector. |
| DisplayCodeFirst | boolean | false | none | Required. Defines whether CODE should appear before TEXT, or vice-versa. |
| ExternalThreshold | integer(int32) | false | none | Optional. Default value is 1. Defines the threshold from where the level starts being external. This value can only be set if a ConnectorID is provided. |
| ID | string | false | none | The unique identifier of the resource. |
| IsVendorList | boolean | false | none | Required. Defines whether it is a vendor list. |
| Name | string | false | none | Required. Defines a name for the list. This name must be unique. |
| SearchCriteriaCode | string | false | none | Required. Defines whether the search criteria should apply to the CODE or to the TEXT. |
| URI | string | false | none | The URI to the resource. |
ListGetCollection
{
"Items": {
"ConnectorID": "string",
"DisplayCodeFirst": true,
"ExternalThreshold": 0,
"ID": "string",
"IsVendorList": true,
"Name": "string",
"SearchCriteriaCode": "string",
"URI": "string"
},
"NextPage": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Items | ListGet | false | none | none |
| NextPage | string | false | none | The URI of the next page of results, if any. |
ListPost
{
"ConnectorID": "string",
"DisplayCodeFirst": true,
"ExternalThreshold": 0,
"IsVendorList": true,
"Name": "string",
"SearchCriteriaCode": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ConnectorID | string | false | none | Optional. Defines the encrypted ConnectorID. If not provided then the list isn't associated with a connector. |
| DisplayCodeFirst | boolean | false | none | Required. Defines whether CODE should appear before TEXT, or vice-versa. |
| ExternalThreshold | integer(int32) | false | none | Optional. Default value is 1. Defines the threshold from where the level starts being external. This value can only be set if a ConnectorID is provided. |
| IsVendorList | boolean | false | none | Required. Defines whether it is a vendor list. |
| Name | string | false | none | Required. Defines a name for the list. This name must be unique. |
| SearchCriteriaCode | string | false | none | Required. Defines whether the search criteria should apply to the CODE or to the TEXT. |
ListPut
{
"DisplayCodeFirst": true,
"Name": "string",
"SearchCriteriaCode": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| DisplayCodeFirst | boolean | false | none | Optional. Defines whether CODE should appear before TEXT, or vice-versa. |
| Name | string | false | none | Optional. Defines a name for the list. This name must be unique. |
| SearchCriteriaCode | string | false | none | Optional. Defines whether the search criteria should apply to the CODE or to the TEXT. |
Localized Data v3.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Invoice includes various status codes, and error messages. This API provides a method to list the localized strings of various codes.
Base URLs:
Resources
get__invoice_localizeddata
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/invoice/localizeddata \
-H 'Accept: application/json'
GET https://www.concursolutions.com/api/v3.0/invoice/localizeddata HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://www.concursolutions.com/api/v3.0/invoice/localizeddata',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/invoice/localizeddata',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/invoice/localizeddata', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/invoice/localizeddata', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/invoice/localizeddata");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/invoice/localizeddata", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /invoice/localizeddata
*Get localized string of various codes in Invoice. *
Returns the localized string of various codes in Invoice.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| type | query | string | false | Valid types are - approvalStatus, paymentStatus, expenseType, ledgerCode, dataSourceCode, payMethod, receiptConfirmation, unitOfMeasure. |
| langCode | query | string | false | Optional. The language code requested. lang codes examples - de, en, es, fr, fr_CA, hu, it, ja, pl, pt_BR |
Example responses
200 Response
{
"LocalizationData": {
"Code": "string",
"LangCode": "string",
"LocalizedValue": "string"
},
"TotalCount": 0
}
<?xml version="1.0" encoding="UTF-8" ?>
<LocalizationDataCollection>
<LocalizationData>
<Code>string</Code>
<LangCode>string</LangCode>
<LocalizedValue>string</LocalizedValue>
</LocalizationData>
<TotalCount>0</TotalCount>
</LocalizationDataCollection>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | LocalizationDataCollection |
Schemas
LocalizationData
{
"Code": "string",
"LangCode": "string",
"LocalizedValue": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Code | string | false | none | Internal status code. |
| LangCode | string | false | none | The language code for the results |
| LocalizedValue | string | false | none | The localized value based on langcode and type. |
LocalizationDataCollection
{
"LocalizationData": {
"Code": "string",
"LangCode": "string",
"LocalizedValue": "string"
},
"TotalCount": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| LocalizationData | LocalizationData | false | none | none |
| TotalCount | integer(int32) | false | none | none |
Locations v3.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
The valid city location codes in SAP Concur. The location codes vary by client, and cannot be used across multiple clients. This API provides methods to get a list of valid locations for the supplied user, or get details of a location by ID.
Base URLs:
Resources
get__common_locations
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/common/locations \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://www.concursolutions.com/api/v3.0/common/locations HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/common/locations',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/common/locations',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/common/locations', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/common/locations', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/common/locations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/common/locations", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /common/locations
Retrieves all locations.
Gets details of locations that are used by SAP Concur and that are valid at the user's company.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| offset | query | string | false | The starting point of the next set of results, after the limit specified in the limit field has been reached. |
| limit | query | integer(int32) | false | The number of records to return. Default value: 25. |
| name | query | string | false | A common name associated with the location. This name can be a location description such as a neighborhood (SoHo), a landmark (Statue of Liberty), or a city name (New York). |
| city | query | string | false | The city name of the location. |
| countrySubdivision | query | string | false | The ISO 3166-2:2007 country subdivision code for the location. Example: US-WA. |
| country | query | string | false | The 2-letter ISO 3166-1 country code for the location. Example: United States is US. |
| administrativeRegion | query | string | false | The administrative region of the location. An administrative region is a government unit, such as a county, that contains one or more cities. |
Example responses
200 Response
{
"Items": {
"AdministrativeRegion": "string",
"Country": "string",
"CountrySubdivision": "string",
"IATACode": "string",
"ID": "string",
"IsAirport": true,
"IsBookingTool": true,
"Latitude": 0,
"Longitude": 0,
"Name": "string",
"URI": "string"
},
"NextPage": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<LocationCollection>
<Items>
<AdministrativeRegion>string</AdministrativeRegion>
<Country>string</Country>
<CountrySubdivision>string</CountrySubdivision>
<IATACode>string</IATACode>
<ID>string</ID>
<IsAirport>true</IsAirport>
<IsBookingTool>true</IsBookingTool>
<Latitude>0</Latitude>
<Longitude>0</Longitude>
<Name>string</Name>
<URI>string</URI>
</Items>
<NextPage>string</NextPage>
</LocationCollection>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | LocationCollection |
get_common_locations{id}
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/common/locations/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://www.concursolutions.com/api/v3.0/common/locations/{id} HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/common/locations/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/common/locations/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/common/locations/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/common/locations/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/common/locations/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/common/locations/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /common/locations/{id}
Retrieves a location by ID.
Gets details of the specified location.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The ID of the location. |
Example responses
200 Response
{
"AdministrativeRegion": "string",
"Country": "string",
"CountrySubdivision": "string",
"IATACode": "string",
"ID": "string",
"IsAirport": true,
"IsBookingTool": true,
"Latitude": 0,
"Longitude": 0,
"Name": "string",
"URI": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<Location>
<AdministrativeRegion>string</AdministrativeRegion>
<Country>string</Country>
<CountrySubdivision>string</CountrySubdivision>
<IATACode>string</IATACode>
<ID>string</ID>
<IsAirport>true</IsAirport>
<IsBookingTool>true</IsBookingTool>
<Latitude>0</Latitude>
<Longitude>0</Longitude>
<Name>string</Name>
<URI>string</URI>
</Location>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Location |
Schemas
Decimal
{}
Properties
None
Location
{
"AdministrativeRegion": "string",
"Country": "string",
"CountrySubdivision": "string",
"IATACode": "string",
"ID": "string",
"IsAirport": true,
"IsBookingTool": true,
"Latitude": 0,
"Longitude": 0,
"Name": "string",
"URI": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| AdministrativeRegion | string | false | none | The administrative region of the location. |
| Country | string | false | none | The 2-letter ISO 3166-1 country code for the location. |
| CountrySubdivision | string | false | none | The ISO 3166-2:2007 country subdivision code for the location. Example: US-WA. |
| IATACode | string | false | none | The International Air Transport Association (IATA) airport code of the location. |
| ID | string | false | none | The unique identifier of the resource. |
| IsAirport | boolean | false | none | Indicates whether the location is an airport. Format: true or false. |
| IsBookingTool | boolean | false | none | Indicates whether the location is used by the booking tool. Format: true or false. |
| Latitude | number(double) | false | none | The latitude of the geocode for the location. |
| Longitude | number(double) | false | none | The longitude of the geocode for the location. |
| Name | string | false | none | The location name. Maximum length: 64 characters. |
| URI | string | false | none | The URI to the resource. |
LocationCollection
{
"Items": {
"AdministrativeRegion": "string",
"Country": "string",
"CountrySubdivision": "string",
"IATACode": "string",
"ID": "string",
"IsAirport": true,
"IsBookingTool": true,
"Latitude": 0,
"Longitude": 0,
"Name": "string",
"URI": "string"
},
"NextPage": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Items | Location | false | none | none |
| NextPage | string | false | none | The URI of the next page of results, if any. |
Nullable_1
{
"HasValue": true,
"Value": {}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| HasValue | boolean | false | none | Indicates whether the location is used by the booking tool. Format: true or false |
| Value | Decimal | false | none | none |
Opportunities v3.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Base URLs:
Resources
get__insights_opportunities
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/insights/opportunities \
-H 'Accept: application/json'
GET https://www.concursolutions.com/api/v3.0/insights/opportunities HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://www.concursolutions.com/api/v3.0/insights/opportunities',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/insights/opportunities',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/insights/opportunities', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/insights/opportunities', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/insights/opportunities");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/insights/opportunities", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /insights/opportunities
Gets a collection of opportunities for a specified trip or for all trips that fall within a date range
Gets a collection of opportunities for a specified trip or for all trips that fall within a date range. Specify values for fromUtc and toUtc to get opportunities for a range of trips. Specify only tripId to get opportunities for a single trip. Specify OpportunityType to filter results by the specified opportunity types.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| tripId | query | string | false | The trip id |
| opportunityType | query | string | false | Comma seperated list of opportunities (Hotel, Car, Air, Rail, Taxi and Service) to get. Do not specify any values to get all opportunities |
| fromUtc | query | string(date-time) | false | The From date in UTC for the date range |
| toUtc | query | string(date-time) | false | The To date in UTC for the date range |
Example responses
200 Response
{
"Items": {
"EndCityCode": "string",
"EndDateLocal": "2019-08-24T14:15:22Z",
"EndPostalCode": "string",
"ID": "string",
"IsActive": true,
"StartCityCode": "string",
"StartDateLocal": "2019-08-24T14:15:22Z",
"StartPostalCode": "string",
"TripId": "string",
"Type": "string",
"URI": "string"
},
"NextPage": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<Opportunities>
<Items>
<EndCityCode>string</EndCityCode>
<EndDateLocal>2019-08-24T14:15:22Z</EndDateLocal>
<EndPostalCode>string</EndPostalCode>
<ID>string</ID>
<IsActive>true</IsActive>
<StartCityCode>string</StartCityCode>
<StartDateLocal>2019-08-24T14:15:22Z</StartDateLocal>
<StartPostalCode>string</StartPostalCode>
<TripId>string</TripId>
<Type>string</Type>
<URI>string</URI>
</Items>
<NextPage>string</NextPage>
</Opportunities>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Opportunities |
Schemas
Opportunities
{
"Items": {
"EndCityCode": "string",
"EndDateLocal": "2019-08-24T14:15:22Z",
"EndPostalCode": "string",
"ID": "string",
"IsActive": true,
"StartCityCode": "string",
"StartDateLocal": "2019-08-24T14:15:22Z",
"StartPostalCode": "string",
"TripId": "string",
"Type": "string",
"URI": "string"
},
"NextPage": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Items | Opportunity | false | none | none |
| NextPage | string | false | none | The URI of the next page of results, if any. |
Opportunity
{
"EndCityCode": "string",
"EndDateLocal": "2019-08-24T14:15:22Z",
"EndPostalCode": "string",
"ID": "string",
"IsActive": true,
"StartCityCode": "string",
"StartDateLocal": "2019-08-24T14:15:22Z",
"StartPostalCode": "string",
"TripId": "string",
"Type": "string",
"URI": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| EndCityCode | string | false | none | The city code of the destination city where the opportunity is offered |
| EndDateLocal | string(date-time) | false | none | The local end date of the location where the opportunity is offered |
| EndPostalCode | string | false | none | The postal code of the destination location where the opportunity is offered |
| ID | string | false | none | The unique identifier of the resource. |
| IsActive | boolean | false | none | Indicates that the opportunity is currently active |
| StartCityCode | string | false | none | The city code of the originating city where the opportunity is offered |
| StartDateLocal | string(date-time) | false | none | The local start date of the location where the opportunity is offered |
| StartPostalCode | string | false | none | The postal code of the originating location where the opportunity is offered |
| TripId | string | false | none | The trip id of the associated itinerary |
| Type | string | false | none | The type of opportunity |
| URI | string | false | none | The URI to the resource. |
Payment Request v3.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
A payment request is a request for payment (partial or full) of an invoice. This API provides methods to create or update a payment request, or view a payment request by ID.
Base URLs:
Resources
get_invoice_paymentrequest{id}
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/invoice/paymentrequest/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://www.concursolutions.com/api/v3.0/invoice/paymentrequest/{id} HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/invoice/paymentrequest/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/invoice/paymentrequest/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/invoice/paymentrequest/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/invoice/paymentrequest/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/invoice/paymentrequest/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/invoice/paymentrequest/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /invoice/paymentrequest/{id}
Gets all Payment Request information.
Gets all relevant information (Payment Request Header, Payment Request Line Item and Payment Request Allocation) of a Payment Request.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Payment Request ID. |
Example responses
200 Response
{
"AmountWithoutVat": "string",
"ApprovalStatus": "string",
"ApprovedByDelegate": "string",
"AssignedByUsername": "string",
"AssignedDate": "string",
"BuyerCostCenter": "string",
"CalculatedAmount": "string",
"CheckNumber": "string",
"CompanyBillToAddress": {
"Address1": "string",
"Address2": "string",
"Address3": "string",
"City": "string",
"CountryCode": "string",
"Name": "string",
"PostalCode": "string",
"State": "string"
},
"CompanyShipToAddress": {
"Address1": "string",
"Address2": "string",
"Address3": "string",
"City": "string",
"CountryCode": "string",
"Name": "string",
"PostalCode": "string",
"State": "string"
},
"CountryCode": "string",
"CreatedByUsername": "string",
"CurrencyCode": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom21": "string",
"Custom22": "string",
"Custom23": "string",
"Custom24": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"DataSource": "string",
"DeletedDate": "string",
"DeliverySlipNumber": "string",
"Description": "string",
"DiscountPercentage": "string",
"DiscountTerms": "string",
"EmployeeName": "string",
"ExternalPolicyId": "string",
"ExtractDate": "string",
"FirstApprovalDate": "string",
"FirstSubmitDate": "string",
"ID": "string",
"InvoiceAmount": "string",
"InvoiceDate": "string",
"InvoiceNumber": "string",
"InvoiceReceivedDate": "string",
"IsAssigned": "string",
"IsInvoiceConfirmed": "string",
"IsPaymentRequestDeleted": "string",
"IsPaymentRequestDuplicate": "string",
"IsTestTransaction": "string",
"LastSubmitDate": "string",
"LedgerCode": "string",
"LineItems": {
"LineItem": {
"Allocations": {
"Allocation": {
"AllocationAccountCode": "string",
"Custom1": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"IsTestUser": "string",
"Percentage": "string"
}
},
"AllocationStatus": "string",
"AmountWithoutVat": "string",
"ApprovedLineItemAmount": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"DeliverySlipNumber": "string",
"Description": "string",
"ExpenseTypeCode": "string",
"IsMatched": "string",
"LineItemId": "string",
"LineItemIsTestUser": "string",
"MatchedPurchaseOrderLineItemId": "string",
"PurchaseOrderNumber": "string",
"Quantity": "string",
"RequestedLineItemAmount": "string",
"RequestLineItemNumber": "string",
"ShipFromPostalCode": "string",
"ShipToPostalCode": "string",
"SupplierPartId": "string",
"Tax": "string",
"TaxCode": "string",
"TaxCode2": "string",
"TaxCode3": "string",
"TaxCode4": "string",
"TotalPrice": "string",
"UnitOfMeasure": "string",
"UnitPrice": "string",
"VatAmount": "string",
"VatAmountFour": "string",
"VatAmountThree": "string",
"VatAmountTwo": "string",
"VatRate": "string",
"VatRateFour": "string",
"VatRateThree": "string",
"VatRateTwo": "string"
}
},
"LineItemTotalAmount": "string",
"LineItemVatAmount": "string",
"Name": "string",
"NotesToVendor": "string",
"OB10BuyerId": "string",
"OB10TransactionId": "string",
"OrgUnit01": "string",
"OrgUnit02": "string",
"OrgUnit03": "string",
"OrgUnit04": "string",
"OrgUnit05": "string",
"OrgUnit06": "string",
"PaidAmount": "string",
"PaidDate": "string",
"PaymentAdjustmentNotes": "string",
"PaymentDueDate": "string",
"PaymentMethod": "string",
"PaymentRequestCreatedByTestUser": "string",
"PaymentRequestDeletedBy": "string",
"PaymentStatus": "string",
"PaymentTermsDays": "string",
"ProvincialTaxId": "string",
"PurchaseOrderNumber": "string",
"ReceiptConfirmationType": "string",
"ShippingAmount": "string",
"SubmittedByDelegate": "string",
"TaxAmount": "string",
"TaxCode": "string",
"TaxCode2": "string",
"TaxCode3": "string",
"TaxCode4": "string",
"TotalApprovedAmount": "string",
"URI": "string",
"UserCreationDate": "string",
"VatAmountFour": "string",
"VatAmountOne": "string",
"VatAmountThree": "string",
"VatAmountTwo": "string",
"VatRateFour": "string",
"VatRateOne": "string",
"VatRateThree": "string",
"VatRateTwo": "string",
"VendorRemitAddress": {
"Address1": "string",
"Address2": "string",
"Address3": "string",
"City": "string",
"CountryCode": "string",
"DiscountTerms": "string",
"Name": "string",
"PostalCode": "string",
"State": "string"
},
"VendorShipFromAddress": {
"Address1": "string",
"Address2": "string",
"Address3": "string",
"City": "string",
"CountryCode": "string",
"DiscountTerms": "string",
"Name": "string",
"PostalCode": "string",
"State": "string"
},
"VendorTaxId": "string",
"WorkflowCompleteDate": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<PaymentRequest>
<AmountWithoutVat>string</AmountWithoutVat>
<ApprovalStatus>string</ApprovalStatus>
<ApprovedByDelegate>string</ApprovedByDelegate>
<AssignedByUsername>string</AssignedByUsername>
<AssignedDate>string</AssignedDate>
<BuyerCostCenter>string</BuyerCostCenter>
<CalculatedAmount>string</CalculatedAmount>
<CheckNumber>string</CheckNumber>
<CompanyBillToAddress>
<Address1>string</Address1>
<Address2>string</Address2>
<Address3>string</Address3>
<City>string</City>
<CountryCode>string</CountryCode>
<Name>string</Name>
<PostalCode>string</PostalCode>
<State>string</State>
</CompanyBillToAddress>
<CompanyShipToAddress>
<Address1>string</Address1>
<Address2>string</Address2>
<Address3>string</Address3>
<City>string</City>
<CountryCode>string</CountryCode>
<Name>string</Name>
<PostalCode>string</PostalCode>
<State>string</State>
</CompanyShipToAddress>
<CountryCode>string</CountryCode>
<CreatedByUsername>string</CreatedByUsername>
<CurrencyCode>string</CurrencyCode>
<Custom1>string</Custom1>
<Custom10>string</Custom10>
<Custom11>string</Custom11>
<Custom12>string</Custom12>
<Custom13>string</Custom13>
<Custom14>string</Custom14>
<Custom15>string</Custom15>
<Custom16>string</Custom16>
<Custom17>string</Custom17>
<Custom18>string</Custom18>
<Custom19>string</Custom19>
<Custom2>string</Custom2>
<Custom20>string</Custom20>
<Custom21>string</Custom21>
<Custom22>string</Custom22>
<Custom23>string</Custom23>
<Custom24>string</Custom24>
<Custom3>string</Custom3>
<Custom4>string</Custom4>
<Custom5>string</Custom5>
<Custom6>string</Custom6>
<Custom7>string</Custom7>
<Custom8>string</Custom8>
<Custom9>string</Custom9>
<DataSource>string</DataSource>
<DeletedDate>string</DeletedDate>
<DeliverySlipNumber>string</DeliverySlipNumber>
<Description>string</Description>
<DiscountPercentage>string</DiscountPercentage>
<DiscountTerms>string</DiscountTerms>
<EmployeeName>string</EmployeeName>
<ExternalPolicyId>string</ExternalPolicyId>
<ExtractDate>string</ExtractDate>
<FirstApprovalDate>string</FirstApprovalDate>
<FirstSubmitDate>string</FirstSubmitDate>
<ID>string</ID>
<InvoiceAmount>string</InvoiceAmount>
<InvoiceDate>string</InvoiceDate>
<InvoiceNumber>string</InvoiceNumber>
<InvoiceReceivedDate>string</InvoiceReceivedDate>
<IsAssigned>string</IsAssigned>
<IsInvoiceConfirmed>string</IsInvoiceConfirmed>
<IsPaymentRequestDeleted>string</IsPaymentRequestDeleted>
<IsPaymentRequestDuplicate>string</IsPaymentRequestDuplicate>
<IsTestTransaction>string</IsTestTransaction>
<LastSubmitDate>string</LastSubmitDate>
<LedgerCode>string</LedgerCode>
<LineItems>
<LineItem>
<Allocations>
<Allocation>
<AllocationAccountCode>string</AllocationAccountCode>
<Custom1>string</Custom1>
<Custom2>string</Custom2>
<Custom3>string</Custom3>
<Custom4>string</Custom4>
<Custom5>string</Custom5>
<Custom6>string</Custom6>
<Custom7>string</Custom7>
<Custom8>string</Custom8>
<Custom9>string</Custom9>
<Custom10>string</Custom10>
<Custom11>string</Custom11>
<Custom12>string</Custom12>
<Custom13>string</Custom13>
<Custom14>string</Custom14>
<Custom15>string</Custom15>
<Custom16>string</Custom16>
<Custom17>string</Custom17>
<Custom18>string</Custom18>
<Custom19>string</Custom19>
<Custom20>string</Custom20>
<IsTestUser>string</IsTestUser>
<Percentage>string</Percentage>
</Allocation>
</Allocations>
<AllocationStatus>string</AllocationStatus>
<AmountWithoutVat>string</AmountWithoutVat>
<ApprovedLineItemAmount>string</ApprovedLineItemAmount>
<Custom1>string</Custom1>
<Custom10>string</Custom10>
<Custom11>string</Custom11>
<Custom12>string</Custom12>
<Custom13>string</Custom13>
<Custom14>string</Custom14>
<Custom15>string</Custom15>
<Custom16>string</Custom16>
<Custom17>string</Custom17>
<Custom18>string</Custom18>
<Custom19>string</Custom19>
<Custom2>string</Custom2>
<Custom20>string</Custom20>
<Custom3>string</Custom3>
<Custom4>string</Custom4>
<Custom5>string</Custom5>
<Custom6>string</Custom6>
<Custom7>string</Custom7>
<Custom8>string</Custom8>
<Custom9>string</Custom9>
<DeliverySlipNumber>string</DeliverySlipNumber>
<Description>string</Description>
<ExpenseTypeCode>string</ExpenseTypeCode>
<IsMatched>string</IsMatched>
<LineItemId>string</LineItemId>
<LineItemIsTestUser>string</LineItemIsTestUser>
<MatchedPurchaseOrderLineItemId>string</MatchedPurchaseOrderLineItemId>
<PurchaseOrderNumber>string</PurchaseOrderNumber>
<Quantity>string</Quantity>
<RequestedLineItemAmount>string</RequestedLineItemAmount>
<RequestLineItemNumber>string</RequestLineItemNumber>
<ShipFromPostalCode>string</ShipFromPostalCode>
<ShipToPostalCode>string</ShipToPostalCode>
<SupplierPartId>string</SupplierPartId>
<Tax>string</Tax>
<TaxCode>string</TaxCode>
<TaxCode2>string</TaxCode2>
<TaxCode3>string</TaxCode3>
<TaxCode4>string</TaxCode4>
<TotalPrice>string</TotalPrice>
<UnitOfMeasure>string</UnitOfMeasure>
<UnitPrice>string</UnitPrice>
<VatAmount>string</VatAmount>
<VatAmountFour>string</VatAmountFour>
<VatAmountThree>string</VatAmountThree>
<VatAmountTwo>string</VatAmountTwo>
<VatRate>string</VatRate>
<VatRateFour>string</VatRateFour>
<VatRateThree>string</VatRateThree>
<VatRateTwo>string</VatRateTwo>
</LineItem>
</LineItems>
<LineItemTotalAmount>string</LineItemTotalAmount>
<LineItemVatAmount>string</LineItemVatAmount>
<Name>string</Name>
<NotesToVendor>string</NotesToVendor>
<OB10BuyerId>string</OB10BuyerId>
<OB10TransactionId>string</OB10TransactionId>
<OrgUnit01>string</OrgUnit01>
<OrgUnit02>string</OrgUnit02>
<OrgUnit03>string</OrgUnit03>
<OrgUnit04>string</OrgUnit04>
<OrgUnit05>string</OrgUnit05>
<OrgUnit06>string</OrgUnit06>
<PaidAmount>string</PaidAmount>
<PaidDate>string</PaidDate>
<PaymentAdjustmentNotes>string</PaymentAdjustmentNotes>
<PaymentDueDate>string</PaymentDueDate>
<PaymentMethod>string</PaymentMethod>
<PaymentRequestCreatedByTestUser>string</PaymentRequestCreatedByTestUser>
<PaymentRequestDeletedBy>string</PaymentRequestDeletedBy>
<PaymentStatus>string</PaymentStatus>
<PaymentTermsDays>string</PaymentTermsDays>
<ProvincialTaxId>string</ProvincialTaxId>
<PurchaseOrderNumber>string</PurchaseOrderNumber>
<ReceiptConfirmationType>string</ReceiptConfirmationType>
<ShippingAmount>string</ShippingAmount>
<SubmittedByDelegate>string</SubmittedByDelegate>
<TaxAmount>string</TaxAmount>
<TaxCode>string</TaxCode>
<TaxCode2>string</TaxCode2>
<TaxCode3>string</TaxCode3>
<TaxCode4>string</TaxCode4>
<TotalApprovedAmount>string</TotalApprovedAmount>
<URI>string</URI>
<UserCreationDate>string</UserCreationDate>
<VatAmountFour>string</VatAmountFour>
<VatAmountOne>string</VatAmountOne>
<VatAmountThree>string</VatAmountThree>
<VatAmountTwo>string</VatAmountTwo>
<VatRateFour>string</VatRateFour>
<VatRateOne>string</VatRateOne>
<VatRateThree>string</VatRateThree>
<VatRateTwo>string</VatRateTwo>
<VendorRemitAddress>
<Address1>string</Address1>
<Address2>string</Address2>
<Address3>string</Address3>
<City>string</City>
<CountryCode>string</CountryCode>
<DiscountTerms>string</DiscountTerms>
<Name>string</Name>
<PostalCode>string</PostalCode>
<State>string</State>
</VendorRemitAddress>
<VendorShipFromAddress>
<Address1>string</Address1>
<Address2>string</Address2>
<Address3>string</Address3>
<City>string</City>
<CountryCode>string</CountryCode>
<DiscountTerms>string</DiscountTerms>
<Name>string</Name>
<PostalCode>string</PostalCode>
<State>string</State>
</VendorShipFromAddress>
<VendorTaxId>string</VendorTaxId>
<WorkflowCompleteDate>string</WorkflowCompleteDate>
</PaymentRequest>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | PaymentRequest |
post__invoice_paymentrequest
Code samples
# You can also use wget
curl -X POST https://www.concursolutions.com/api/v3.0/invoice/paymentrequest \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://www.concursolutions.com/api/v3.0/invoice/paymentrequest HTTP/1.1
Host: www.concursolutions.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"AmountWithoutVat": "string",
"BuyerCostCenter": "string",
"CheckNumber": "string",
"CompanyBillToAddressCode": "string",
"CompanyShipToAddressCode": "string",
"CountryCode": "string",
"CurrencyCode": "string",
"Custom01": "string",
"Custom02": "string",
"Custom03": "string",
"Custom04": "string",
"Custom05": "string",
"Custom06": "string",
"Custom07": "string",
"Custom08": "string",
"Custom09": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"Custom21": "string",
"Custom22": "string",
"Custom23": "string",
"Custom24": "string",
"DataSource": "string",
"DeliverySlipNumber": "string",
"Description": "string",
"DiscountPercentage": "string",
"DiscountTerms": "string",
"EmployeeEmailAddress": "string",
"EmployeeId": "string",
"EmployeeLoginId": "string",
"ExternalPolicyId": "string",
"InvoiceAmount": "string",
"InvoiceDate": "string",
"InvoiceNumber": "string",
"InvoiceReceivedDate": "string",
"IsEmergencyCheckRun": "string",
"IsInvoiceConfirmed": "string",
"LedgerCode": "string",
"LineItems": {
"Allocations": {
"Custom01": "string",
"Custom02": "string",
"Custom03": "string",
"Custom04": "string",
"Custom05": "string",
"Custom06": "string",
"Custom07": "string",
"Custom08": "string",
"Custom09": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"Percentage": "string"
},
"AmountWithoutVat": "string",
"Custom01": "string",
"Custom02": "string",
"Custom03": "string",
"Custom04": "string",
"Custom05": "string",
"Custom06": "string",
"Custom07": "string",
"Custom08": "string",
"Custom09": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"Description": "string",
"ExpenseTypeCode": "string",
"ItemCode": "string",
"PurchaseOrderNumber": "string",
"Quantity": "string",
"ShipFromPostalCode": "string",
"ShipToPostalCode": "string",
"SupplierPartId": "string",
"Tax": "string",
"TaxCode": "string",
"TaxCode2": "string",
"TaxCode3": "string",
"TaxCode4": "string",
"TotalPrice": "string",
"UnitOfMeasure": "string",
"UnitPrice": "string",
"VatAmount": "string",
"VatAmountFour": "string",
"VatAmountThree": "string",
"VatAmountTwo": "string",
"VatRate": "string",
"VatRateFour": "string",
"VatRateThree": "string",
"VatRateTwo": "string"
},
"Name": "string",
"NotesToVendor": "string",
"OB10BuyerId": "string",
"OB10TransactionId": "string",
"OrgUnit01": "string",
"OrgUnit02": "string",
"OrgUnit03": "string",
"OrgUnit04": "string",
"OrgUnit05": "string",
"OrgUnit06": "string",
"PaymentAdjustmentNotes": "string",
"PaymentAmount": "string",
"PaymentDueDate": "string",
"PaymentTermsDays": "string",
"ProvincialTaxId": "string",
"PurchaseOrderId": "string",
"ReceiptConfirmationType": "string",
"ShippingAmount": "string",
"TaxAmount": "string",
"VatAmountFour": "string",
"VatAmountOne": "string",
"VatAmountThree": "string",
"VatAmountTwo": "string",
"VatRateFour": "string",
"VatRateOne": "string",
"VatRateThree": "string",
"VatRateTwo": "string",
"VendorRemitToIdentifier": {
"Address1": "string",
"AddressCode": "string",
"Name": "string",
"PostalCode": "string",
"VendorCode": "string"
},
"VendorShipFromAddressCode": "string",
"VendorTaxId": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/invoice/paymentrequest',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://www.concursolutions.com/api/v3.0/invoice/paymentrequest',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://www.concursolutions.com/api/v3.0/invoice/paymentrequest', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://www.concursolutions.com/api/v3.0/invoice/paymentrequest', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/invoice/paymentrequest");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://www.concursolutions.com/api/v3.0/invoice/paymentrequest", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /invoice/paymentrequest
Create a Payment Request.
Creates a new Payment Request with all relevant details including line items and associated allocations.
Body parameter
{
"AmountWithoutVat": "string",
"BuyerCostCenter": "string",
"CheckNumber": "string",
"CompanyBillToAddressCode": "string",
"CompanyShipToAddressCode": "string",
"CountryCode": "string",
"CurrencyCode": "string",
"Custom01": "string",
"Custom02": "string",
"Custom03": "string",
"Custom04": "string",
"Custom05": "string",
"Custom06": "string",
"Custom07": "string",
"Custom08": "string",
"Custom09": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"Custom21": "string",
"Custom22": "string",
"Custom23": "string",
"Custom24": "string",
"DataSource": "string",
"DeliverySlipNumber": "string",
"Description": "string",
"DiscountPercentage": "string",
"DiscountTerms": "string",
"EmployeeEmailAddress": "string",
"EmployeeId": "string",
"EmployeeLoginId": "string",
"ExternalPolicyId": "string",
"InvoiceAmount": "string",
"InvoiceDate": "string",
"InvoiceNumber": "string",
"InvoiceReceivedDate": "string",
"IsEmergencyCheckRun": "string",
"IsInvoiceConfirmed": "string",
"LedgerCode": "string",
"LineItems": {
"Allocations": {
"Custom01": "string",
"Custom02": "string",
"Custom03": "string",
"Custom04": "string",
"Custom05": "string",
"Custom06": "string",
"Custom07": "string",
"Custom08": "string",
"Custom09": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"Percentage": "string"
},
"AmountWithoutVat": "string",
"Custom01": "string",
"Custom02": "string",
"Custom03": "string",
"Custom04": "string",
"Custom05": "string",
"Custom06": "string",
"Custom07": "string",
"Custom08": "string",
"Custom09": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"Description": "string",
"ExpenseTypeCode": "string",
"ItemCode": "string",
"PurchaseOrderNumber": "string",
"Quantity": "string",
"ShipFromPostalCode": "string",
"ShipToPostalCode": "string",
"SupplierPartId": "string",
"Tax": "string",
"TaxCode": "string",
"TaxCode2": "string",
"TaxCode3": "string",
"TaxCode4": "string",
"TotalPrice": "string",
"UnitOfMeasure": "string",
"UnitPrice": "string",
"VatAmount": "string",
"VatAmountFour": "string",
"VatAmountThree": "string",
"VatAmountTwo": "string",
"VatRate": "string",
"VatRateFour": "string",
"VatRateThree": "string",
"VatRateTwo": "string"
},
"Name": "string",
"NotesToVendor": "string",
"OB10BuyerId": "string",
"OB10TransactionId": "string",
"OrgUnit01": "string",
"OrgUnit02": "string",
"OrgUnit03": "string",
"OrgUnit04": "string",
"OrgUnit05": "string",
"OrgUnit06": "string",
"PaymentAdjustmentNotes": "string",
"PaymentAmount": "string",
"PaymentDueDate": "string",
"PaymentTermsDays": "string",
"ProvincialTaxId": "string",
"PurchaseOrderId": "string",
"ReceiptConfirmationType": "string",
"ShippingAmount": "string",
"TaxAmount": "string",
"VatAmountFour": "string",
"VatAmountOne": "string",
"VatAmountThree": "string",
"VatAmountTwo": "string",
"VatRateFour": "string",
"VatRateOne": "string",
"VatRateThree": "string",
"VatRateTwo": "string",
"VendorRemitToIdentifier": {
"Address1": "string",
"AddressCode": "string",
"Name": "string",
"PostalCode": "string",
"VendorCode": "string"
},
"VendorShipFromAddressCode": "string",
"VendorTaxId": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<PaymentRequestPost>
<AmountWithoutVat>string</AmountWithoutVat>
<BuyerCostCenter>string</BuyerCostCenter>
<CheckNumber>string</CheckNumber>
<CompanyBillToAddressCode>string</CompanyBillToAddressCode>
<CompanyShipToAddressCode>string</CompanyShipToAddressCode>
<CountryCode>string</CountryCode>
<CurrencyCode>string</CurrencyCode>
<Custom01>string</Custom01>
<Custom02>string</Custom02>
<Custom03>string</Custom03>
<Custom04>string</Custom04>
<Custom05>string</Custom05>
<Custom06>string</Custom06>
<Custom07>string</Custom07>
<Custom08>string</Custom08>
<Custom09>string</Custom09>
<Custom10>string</Custom10>
<Custom11>string</Custom11>
<Custom12>string</Custom12>
<Custom13>string</Custom13>
<Custom14>string</Custom14>
<Custom15>string</Custom15>
<Custom16>string</Custom16>
<Custom17>string</Custom17>
<Custom18>string</Custom18>
<Custom19>string</Custom19>
<Custom20>string</Custom20>
<Custom21>string</Custom21>
<Custom22>string</Custom22>
<Custom23>string</Custom23>
<Custom24>string</Custom24>
<DataSource>string</DataSource>
<DeliverySlipNumber>string</DeliverySlipNumber>
<Description>string</Description>
<DiscountPercentage>string</DiscountPercentage>
<DiscountTerms>string</DiscountTerms>
<EmployeeEmailAddress>string</EmployeeEmailAddress>
<EmployeeId>string</EmployeeId>
<EmployeeLoginId>string</EmployeeLoginId>
<ExternalPolicyId>string</ExternalPolicyId>
<InvoiceAmount>string</InvoiceAmount>
<InvoiceDate>string</InvoiceDate>
<InvoiceNumber>string</InvoiceNumber>
<InvoiceReceivedDate>string</InvoiceReceivedDate>
<IsEmergencyCheckRun>string</IsEmergencyCheckRun>
<IsInvoiceConfirmed>string</IsInvoiceConfirmed>
<LedgerCode>string</LedgerCode>
<LineItems>
<Allocations>
<Custom01>string</Custom01>
<Custom02>string</Custom02>
<Custom03>string</Custom03>
<Custom04>string</Custom04>
<Custom05>string</Custom05>
<Custom06>string</Custom06>
<Custom07>string</Custom07>
<Custom08>string</Custom08>
<Custom09>string</Custom09>
<Custom10>string</Custom10>
<Custom11>string</Custom11>
<Custom12>string</Custom12>
<Custom13>string</Custom13>
<Custom14>string</Custom14>
<Custom15>string</Custom15>
<Custom16>string</Custom16>
<Custom17>string</Custom17>
<Custom18>string</Custom18>
<Custom19>string</Custom19>
<Custom20>string</Custom20>
<Percentage>string</Percentage>
</Allocations>
<AmountWithoutVat>string</AmountWithoutVat>
<Custom01>string</Custom01>
<Custom02>string</Custom02>
<Custom03>string</Custom03>
<Custom04>string</Custom04>
<Custom05>string</Custom05>
<Custom06>string</Custom06>
<Custom07>string</Custom07>
<Custom08>string</Custom08>
<Custom09>string</Custom09>
<Custom10>string</Custom10>
<Custom11>string</Custom11>
<Custom12>string</Custom12>
<Custom13>string</Custom13>
<Custom14>string</Custom14>
<Custom15>string</Custom15>
<Custom16>string</Custom16>
<Custom17>string</Custom17>
<Custom18>string</Custom18>
<Custom19>string</Custom19>
<Custom20>string</Custom20>
<Description>string</Description>
<ExpenseTypeCode>string</ExpenseTypeCode>
<ItemCode>string</ItemCode>
<PurchaseOrderNumber>string</PurchaseOrderNumber>
<Quantity>string</Quantity>
<ShipFromPostalCode>string</ShipFromPostalCode>
<ShipToPostalCode>string</ShipToPostalCode>
<SupplierPartId>string</SupplierPartId>
<Tax>string</Tax>
<TaxCode>string</TaxCode>
<TaxCode2>string</TaxCode2>
<TaxCode3>string</TaxCode3>
<TaxCode4>string</TaxCode4>
<TotalPrice>string</TotalPrice>
<UnitOfMeasure>string</UnitOfMeasure>
<UnitPrice>string</UnitPrice>
<VatAmount>string</VatAmount>
<VatAmountFour>string</VatAmountFour>
<VatAmountThree>string</VatAmountThree>
<VatAmountTwo>string</VatAmountTwo>
<VatRate>string</VatRate>
<VatRateFour>string</VatRateFour>
<VatRateThree>string</VatRateThree>
<VatRateTwo>string</VatRateTwo>
</LineItems>
<Name>string</Name>
<NotesToVendor>string</NotesToVendor>
<OB10BuyerId>string</OB10BuyerId>
<OB10TransactionId>string</OB10TransactionId>
<OrgUnit01>string</OrgUnit01>
<OrgUnit02>string</OrgUnit02>
<OrgUnit03>string</OrgUnit03>
<OrgUnit04>string</OrgUnit04>
<OrgUnit05>string</OrgUnit05>
<OrgUnit06>string</OrgUnit06>
<PaymentAdjustmentNotes>string</PaymentAdjustmentNotes>
<PaymentAmount>string</PaymentAmount>
<PaymentDueDate>string</PaymentDueDate>
<PaymentTermsDays>string</PaymentTermsDays>
<ProvincialTaxId>string</ProvincialTaxId>
<PurchaseOrderId>string</PurchaseOrderId>
<ReceiptConfirmationType>string</ReceiptConfirmationType>
<ShippingAmount>string</ShippingAmount>
<TaxAmount>string</TaxAmount>
<VatAmountFour>string</VatAmountFour>
<VatAmountOne>string</VatAmountOne>
<VatAmountThree>string</VatAmountThree>
<VatAmountTwo>string</VatAmountTwo>
<VatRateFour>string</VatRateFour>
<VatRateOne>string</VatRateOne>
<VatRateThree>string</VatRateThree>
<VatRateTwo>string</VatRateTwo>
<VendorRemitToIdentifier>
<Address1>string</Address1>
<AddressCode>string</AddressCode>
<Name>string</Name>
<PostalCode>string</PostalCode>
<VendorCode>string</VendorCode>
</VendorRemitToIdentifier>
<VendorShipFromAddressCode>string</VendorShipFromAddressCode>
<VendorTaxId>string</VendorTaxId>
</PaymentRequestPost>
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | PaymentRequestPost | true | An XML or JSON representation of a Payment Request. |
Example responses
200 Response
{
"ID": "string",
"URI": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CreateResponse>
<ID>string</ID>
<URI>string</URI>
</CreateResponse>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | CreateResponse |
| 400 | Bad Request | Bad Request | Void |
put__invoice_paymentrequest
Code samples
# You can also use wget
curl -X PUT https://www.concursolutions.com/api/v3.0/invoice/paymentrequest \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
PUT https://www.concursolutions.com/api/v3.0/invoice/paymentrequest HTTP/1.1
Host: www.concursolutions.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"AmountWithoutVat": "string",
"BuyerCostCenter": "string",
"CheckNumber": "string",
"CompanyBillToAddressCode": "string",
"CompanyShipToAddressCode": "string",
"CountryCode": "string",
"CurrencyCode": "string",
"Custom01": "string",
"Custom02": "string",
"Custom03": "string",
"Custom04": "string",
"Custom05": "string",
"Custom06": "string",
"Custom07": "string",
"Custom08": "string",
"Custom09": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"Custom21": "string",
"Custom22": "string",
"Custom23": "string",
"Custom24": "string",
"DeliverySlipNumber": "string",
"Description": "string",
"DiscountPercentage": "string",
"DiscountTerms": "string",
"DoCopyDown": "string",
"DoCopyDownFromPO": "string",
"EmployeeEmailAddress": "string",
"EmployeeId": "string",
"EmployeeLoginId": "string",
"InvoiceAmount": "string",
"InvoiceDate": "string",
"InvoiceNumber": "string",
"InvoiceReceivedDate": "string",
"IsEmergencyCheckRun": "string",
"IsInvoiceConfirmed": "string",
"LineItems": {
"Action": "string",
"Allocations": {
"Custom01": "string",
"Custom02": "string",
"Custom03": "string",
"Custom04": "string",
"Custom05": "string",
"Custom06": "string",
"Custom07": "string",
"Custom08": "string",
"Custom09": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"Percentage": "string"
},
"AmountWithoutVat": "string",
"Custom01": "string",
"Custom02": "string",
"Custom03": "string",
"Custom04": "string",
"Custom05": "string",
"Custom06": "string",
"Custom07": "string",
"Custom08": "string",
"Custom09": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"Description": "string",
"ExpenseTypeCode": "string",
"ItemCode": "string",
"LineItemID": "string",
"PurchaseOrderNumber": "string",
"Quantity": "string",
"ShipFromPostalCode": "string",
"ShipToPostalCode": "string",
"SupplierPartId": "string",
"Tax": "string",
"TaxCode": "string",
"TaxCode2": "string",
"TaxCode3": "string",
"TaxCode4": "string",
"UnitOfMeasure": "string",
"UnitPrice": "string",
"VatAmount": "string",
"VatAmountFour": "string",
"VatAmountThree": "string",
"VatAmountTwo": "string",
"VatRate": "string",
"VatRateFour": "string",
"VatRateThree": "string",
"VatRateTwo": "string"
},
"Name": "string",
"NotesToVendor": "string",
"OB10BuyerId": "string",
"OB10TransactionId": "string",
"OrgUnit01": "string",
"OrgUnit02": "string",
"OrgUnit03": "string",
"OrgUnit04": "string",
"OrgUnit05": "string",
"OrgUnit06": "string",
"PaymentAdjustmentNotes": "string",
"PaymentAmount": "string",
"PaymentDueDate": "string",
"PaymentTermsDays": "string",
"ProvincialTaxId": "string",
"PurchaseOrderId": "string",
"ReceiptConfirmationType": "string",
"RequestID": "string",
"ShippingAmount": "string",
"TaxAmount": "string",
"VatAmountFour": "string",
"VatAmountOne": "string",
"VatAmountThree": "string",
"VatAmountTwo": "string",
"VatRateFour": "string",
"VatRateOne": "string",
"VatRateThree": "string",
"VatRateTwo": "string",
"VendorRemitToIdentifier": {
"Address1": "string",
"AddressCode": "string",
"Name": "string",
"PostalCode": "string",
"VendorCode": "string"
},
"VendorShipFromAddressCode": "string",
"VendorTaxId": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/invoice/paymentrequest',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put 'https://www.concursolutions.com/api/v3.0/invoice/paymentrequest',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('https://www.concursolutions.com/api/v3.0/invoice/paymentrequest', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','https://www.concursolutions.com/api/v3.0/invoice/paymentrequest', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/invoice/paymentrequest");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://www.concursolutions.com/api/v3.0/invoice/paymentrequest", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /invoice/paymentrequest
Update a Payment Request.
Updates a payment request with all relevant details including line items and associated allocations.
Body parameter
{
"AmountWithoutVat": "string",
"BuyerCostCenter": "string",
"CheckNumber": "string",
"CompanyBillToAddressCode": "string",
"CompanyShipToAddressCode": "string",
"CountryCode": "string",
"CurrencyCode": "string",
"Custom01": "string",
"Custom02": "string",
"Custom03": "string",
"Custom04": "string",
"Custom05": "string",
"Custom06": "string",
"Custom07": "string",
"Custom08": "string",
"Custom09": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"Custom21": "string",
"Custom22": "string",
"Custom23": "string",
"Custom24": "string",
"DeliverySlipNumber": "string",
"Description": "string",
"DiscountPercentage": "string",
"DiscountTerms": "string",
"DoCopyDown": "string",
"DoCopyDownFromPO": "string",
"EmployeeEmailAddress": "string",
"EmployeeId": "string",
"EmployeeLoginId": "string",
"InvoiceAmount": "string",
"InvoiceDate": "string",
"InvoiceNumber": "string",
"InvoiceReceivedDate": "string",
"IsEmergencyCheckRun": "string",
"IsInvoiceConfirmed": "string",
"LineItems": {
"Action": "string",
"Allocations": {
"Custom01": "string",
"Custom02": "string",
"Custom03": "string",
"Custom04": "string",
"Custom05": "string",
"Custom06": "string",
"Custom07": "string",
"Custom08": "string",
"Custom09": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"Percentage": "string"
},
"AmountWithoutVat": "string",
"Custom01": "string",
"Custom02": "string",
"Custom03": "string",
"Custom04": "string",
"Custom05": "string",
"Custom06": "string",
"Custom07": "string",
"Custom08": "string",
"Custom09": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"Description": "string",
"ExpenseTypeCode": "string",
"ItemCode": "string",
"LineItemID": "string",
"PurchaseOrderNumber": "string",
"Quantity": "string",
"ShipFromPostalCode": "string",
"ShipToPostalCode": "string",
"SupplierPartId": "string",
"Tax": "string",
"TaxCode": "string",
"TaxCode2": "string",
"TaxCode3": "string",
"TaxCode4": "string",
"UnitOfMeasure": "string",
"UnitPrice": "string",
"VatAmount": "string",
"VatAmountFour": "string",
"VatAmountThree": "string",
"VatAmountTwo": "string",
"VatRate": "string",
"VatRateFour": "string",
"VatRateThree": "string",
"VatRateTwo": "string"
},
"Name": "string",
"NotesToVendor": "string",
"OB10BuyerId": "string",
"OB10TransactionId": "string",
"OrgUnit01": "string",
"OrgUnit02": "string",
"OrgUnit03": "string",
"OrgUnit04": "string",
"OrgUnit05": "string",
"OrgUnit06": "string",
"PaymentAdjustmentNotes": "string",
"PaymentAmount": "string",
"PaymentDueDate": "string",
"PaymentTermsDays": "string",
"ProvincialTaxId": "string",
"PurchaseOrderId": "string",
"ReceiptConfirmationType": "string",
"RequestID": "string",
"ShippingAmount": "string",
"TaxAmount": "string",
"VatAmountFour": "string",
"VatAmountOne": "string",
"VatAmountThree": "string",
"VatAmountTwo": "string",
"VatRateFour": "string",
"VatRateOne": "string",
"VatRateThree": "string",
"VatRateTwo": "string",
"VendorRemitToIdentifier": {
"Address1": "string",
"AddressCode": "string",
"Name": "string",
"PostalCode": "string",
"VendorCode": "string"
},
"VendorShipFromAddressCode": "string",
"VendorTaxId": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<PaymentRequestPut>
<AmountWithoutVat>string</AmountWithoutVat>
<BuyerCostCenter>string</BuyerCostCenter>
<CheckNumber>string</CheckNumber>
<CompanyBillToAddressCode>string</CompanyBillToAddressCode>
<CompanyShipToAddressCode>string</CompanyShipToAddressCode>
<CountryCode>string</CountryCode>
<CurrencyCode>string</CurrencyCode>
<Custom01>string</Custom01>
<Custom02>string</Custom02>
<Custom03>string</Custom03>
<Custom04>string</Custom04>
<Custom05>string</Custom05>
<Custom06>string</Custom06>
<Custom07>string</Custom07>
<Custom08>string</Custom08>
<Custom09>string</Custom09>
<Custom10>string</Custom10>
<Custom11>string</Custom11>
<Custom12>string</Custom12>
<Custom13>string</Custom13>
<Custom14>string</Custom14>
<Custom15>string</Custom15>
<Custom16>string</Custom16>
<Custom17>string</Custom17>
<Custom18>string</Custom18>
<Custom19>string</Custom19>
<Custom20>string</Custom20>
<Custom21>string</Custom21>
<Custom22>string</Custom22>
<Custom23>string</Custom23>
<Custom24>string</Custom24>
<DeliverySlipNumber>string</DeliverySlipNumber>
<Description>string</Description>
<DiscountPercentage>string</DiscountPercentage>
<DiscountTerms>string</DiscountTerms>
<DoCopyDown>string</DoCopyDown>
<DoCopyDownFromPO>string</DoCopyDownFromPO>
<EmployeeEmailAddress>string</EmployeeEmailAddress>
<EmployeeId>string</EmployeeId>
<EmployeeLoginId>string</EmployeeLoginId>
<InvoiceAmount>string</InvoiceAmount>
<InvoiceDate>string</InvoiceDate>
<InvoiceNumber>string</InvoiceNumber>
<InvoiceReceivedDate>string</InvoiceReceivedDate>
<IsEmergencyCheckRun>string</IsEmergencyCheckRun>
<IsInvoiceConfirmed>string</IsInvoiceConfirmed>
<LineItems>
<Action>string</Action>
<Allocations>
<Custom01>string</Custom01>
<Custom02>string</Custom02>
<Custom03>string</Custom03>
<Custom04>string</Custom04>
<Custom05>string</Custom05>
<Custom06>string</Custom06>
<Custom07>string</Custom07>
<Custom08>string</Custom08>
<Custom09>string</Custom09>
<Custom10>string</Custom10>
<Custom11>string</Custom11>
<Custom12>string</Custom12>
<Custom13>string</Custom13>
<Custom14>string</Custom14>
<Custom15>string</Custom15>
<Custom16>string</Custom16>
<Custom17>string</Custom17>
<Custom18>string</Custom18>
<Custom19>string</Custom19>
<Custom20>string</Custom20>
<Percentage>string</Percentage>
</Allocations>
<AmountWithoutVat>string</AmountWithoutVat>
<Custom01>string</Custom01>
<Custom02>string</Custom02>
<Custom03>string</Custom03>
<Custom04>string</Custom04>
<Custom05>string</Custom05>
<Custom06>string</Custom06>
<Custom07>string</Custom07>
<Custom08>string</Custom08>
<Custom09>string</Custom09>
<Custom10>string</Custom10>
<Custom11>string</Custom11>
<Custom12>string</Custom12>
<Custom13>string</Custom13>
<Custom14>string</Custom14>
<Custom15>string</Custom15>
<Custom16>string</Custom16>
<Custom17>string</Custom17>
<Custom18>string</Custom18>
<Custom19>string</Custom19>
<Custom20>string</Custom20>
<Description>string</Description>
<ExpenseTypeCode>string</ExpenseTypeCode>
<ItemCode>string</ItemCode>
<LineItemID>string</LineItemID>
<PurchaseOrderNumber>string</PurchaseOrderNumber>
<Quantity>string</Quantity>
<ShipFromPostalCode>string</ShipFromPostalCode>
<ShipToPostalCode>string</ShipToPostalCode>
<SupplierPartId>string</SupplierPartId>
<Tax>string</Tax>
<TaxCode>string</TaxCode>
<TaxCode2>string</TaxCode2>
<TaxCode3>string</TaxCode3>
<TaxCode4>string</TaxCode4>
<UnitOfMeasure>string</UnitOfMeasure>
<UnitPrice>string</UnitPrice>
<VatAmount>string</VatAmount>
<VatAmountFour>string</VatAmountFour>
<VatAmountThree>string</VatAmountThree>
<VatAmountTwo>string</VatAmountTwo>
<VatRate>string</VatRate>
<VatRateFour>string</VatRateFour>
<VatRateThree>string</VatRateThree>
<VatRateTwo>string</VatRateTwo>
</LineItems>
<Name>string</Name>
<NotesToVendor>string</NotesToVendor>
<OB10BuyerId>string</OB10BuyerId>
<OB10TransactionId>string</OB10TransactionId>
<OrgUnit01>string</OrgUnit01>
<OrgUnit02>string</OrgUnit02>
<OrgUnit03>string</OrgUnit03>
<OrgUnit04>string</OrgUnit04>
<OrgUnit05>string</OrgUnit05>
<OrgUnit06>string</OrgUnit06>
<PaymentAdjustmentNotes>string</PaymentAdjustmentNotes>
<PaymentAmount>string</PaymentAmount>
<PaymentDueDate>string</PaymentDueDate>
<PaymentTermsDays>string</PaymentTermsDays>
<ProvincialTaxId>string</ProvincialTaxId>
<PurchaseOrderId>string</PurchaseOrderId>
<ReceiptConfirmationType>string</ReceiptConfirmationType>
<RequestID>string</RequestID>
<ShippingAmount>string</ShippingAmount>
<TaxAmount>string</TaxAmount>
<VatAmountFour>string</VatAmountFour>
<VatAmountOne>string</VatAmountOne>
<VatAmountThree>string</VatAmountThree>
<VatAmountTwo>string</VatAmountTwo>
<VatRateFour>string</VatRateFour>
<VatRateOne>string</VatRateOne>
<VatRateThree>string</VatRateThree>
<VatRateTwo>string</VatRateTwo>
<VendorRemitToIdentifier>
<Address1>string</Address1>
<AddressCode>string</AddressCode>
<Name>string</Name>
<PostalCode>string</PostalCode>
<VendorCode>string</VendorCode>
</VendorRemitToIdentifier>
<VendorShipFromAddressCode>string</VendorShipFromAddressCode>
<VendorTaxId>string</VendorTaxId>
</PaymentRequestPut>
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | PaymentRequestPut | true | An XML or JSON representation of a Payment Request. |
Example responses
200 Response
{
"ID": "string",
"URI": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CreateResponse>
<ID>string</ID>
<URI>string</URI>
</CreateResponse>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | CreateResponse |
| 400 | Bad Request | Bad Request | Void |
Schemas
Allocation
{
"AllocationAccountCode": "string",
"Custom1": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"IsTestUser": "string",
"Percentage": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| AllocationAccountCode | string | false | none | The Account Code that the allocation will be assigned to. |
| Custom1 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom2 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom3 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom4 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom5 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom6 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom7 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom8 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom9 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom10 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom11 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom12 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom13 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom14 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom15 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom16 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom17 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom18 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom19 | string | false | none | A value that can be applied to a custom field 8 that is part of the allocation form. |
| Custom20 | string | false | none | A value that can be applied to a custom field 9 that is part of the allocation form. |
| IsTestUser | string | false | none | Indication that the Allocation record was created by a test user. Format: true/false. |
| Percentage | string | false | none | The percentage of the request line item that the individual allocation records. All allocations associated to a given line item should add up to 100. |
AllocationsCollection
{
"Allocation": {
"AllocationAccountCode": "string",
"Custom1": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"IsTestUser": "string",
"Percentage": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Allocation | Allocation | false | none | none |
CompanyAddress
{
"Address1": "string",
"Address2": "string",
"Address3": "string",
"City": "string",
"CountryCode": "string",
"Name": "string",
"PostalCode": "string",
"State": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Address1 | string | false | none | Line 1 of the street address. |
| Address2 | string | false | none | Line 2 of the street address |
| Address3 | string | false | none | Line 3 of the street address |
| City | string | false | none | The name of the city. |
| CountryCode | string | false | none | The country code. |
| Name | string | false | none | The name given to the company location. |
| PostalCode | string | false | none | The postal / zip code. |
| State | string | false | none | The state code. |
CreateResponse
{
"ID": "string",
"URI": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ID | string | false | none | The ID of the resource. |
| URI | string | false | none | The URI to the resource. |
LineItem
{
"Allocations": {
"Allocation": {
"AllocationAccountCode": "string",
"Custom1": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"IsTestUser": "string",
"Percentage": "string"
}
},
"AllocationStatus": "string",
"AmountWithoutVat": "string",
"ApprovedLineItemAmount": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"DeliverySlipNumber": "string",
"Description": "string",
"ExpenseTypeCode": "string",
"IsMatched": "string",
"LineItemId": "string",
"LineItemIsTestUser": "string",
"MatchedPurchaseOrderLineItemId": "string",
"PurchaseOrderNumber": "string",
"Quantity": "string",
"RequestedLineItemAmount": "string",
"RequestLineItemNumber": "string",
"ShipFromPostalCode": "string",
"ShipToPostalCode": "string",
"SupplierPartId": "string",
"Tax": "string",
"TaxCode": "string",
"TaxCode2": "string",
"TaxCode3": "string",
"TaxCode4": "string",
"TotalPrice": "string",
"UnitOfMeasure": "string",
"UnitPrice": "string",
"VatAmount": "string",
"VatAmountFour": "string",
"VatAmountThree": "string",
"VatAmountTwo": "string",
"VatRate": "string",
"VatRateFour": "string",
"VatRateThree": "string",
"VatRateTwo": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Allocations | AllocationsCollection | false | none | none |
| AllocationStatus | string | false | none | Current amount of allocation performed on the Request line item Supported values: None, Partial, Full. |
| AmountWithoutVat | string | false | none | The net amount of the line item, excluding VAT. |
| ApprovedLineItemAmount | string | false | none | The approved amount of the line item. |
| Custom1 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom10 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom11 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom12 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom13 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom14 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom15 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom16 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom17 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom18 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom19 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom2 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom20 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom3 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom4 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom5 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom6 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom7 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom8 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom9 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| DeliverySlipNumber | string | false | none | The delivery slip number associated with receiving receipt. |
| Description | string | false | none | Brief overview of the good or service ordered. |
| ExpenseTypeCode | string | false | none | A code which indicates the expense type for the line item. |
| IsMatched | string | false | none | Indication that the payment request line item is associated to a purchase order line item. Format: true/false. |
| LineItemId | string | false | none | The identifier of the payment request line item. The ID is only guaranteed to be unique for a given payment request. |
| LineItemIsTestUser | string | false | none | Indication that the allocation record was created by a test user. Format: true/false. |
| MatchedPurchaseOrderLineItemId | string | false | none | The identifier of the purchase order line item to which the payment request line item is matched (if any). |
| PurchaseOrderNumber | string | false | none | The identifier of the purchase order containing the line item to which the payment request line item is matched (if any). |
| Quantity | string | false | none | Total number of goods or services ordered. |
| RequestedLineItemAmount | string | false | none | The requested amount of the line item. |
| RequestLineItemNumber | string | false | none | The relative location of the line item in relation to other line items in the payment request. |
| ShipFromPostalCode | string | false | none | The postal code the good or service was shipped from. |
| ShipToPostalCode | string | false | none | The postal code the good or service will be shipped to. |
| SupplierPartId | string | false | none | The unique identifier provided by the supplier that is associated with the good or service. |
| Tax | string | false | none | The tax associated with the line item. |
| TaxCode | string | false | none | The tax code assigned for the line item, based on the tax setting. |
| TaxCode2 | string | false | none | The tax code 2 assigned for the line item, based on the tax setting. |
| TaxCode3 | string | false | none | The tax code 3 assigned for the line item, based on the tax setting. |
| TaxCode4 | string | false | none | The tax code 4 assigned for the line item, based on the tax setting. |
| TotalPrice | string | false | none | The total amount of the line item. |
| UnitOfMeasure | string | false | none | The code for the measurement unit used to quantify the good or service. Use "GET /invoice/localizeddata" to look up codes and descriptions. |
| UnitPrice | string | false | none | The cost for a single unit of the line item good or service. |
| VatAmount | string | false | none | The amount of VAT 1 included in the line item total. |
| VatAmountFour | string | false | none | The amount of VAT 4 included in the line item total. |
| VatAmountThree | string | false | none | The amount of VAT 3 included in the line item total. |
| VatAmountTwo | string | false | none | The amount of VAT 2 included in the line item total. |
| VatRate | string | false | none | The VAT rate 1 applied to the net line item total. |
| VatRateFour | string | false | none | The VAT rate 4 applied to the net line item total. |
| VatRateThree | string | false | none | The VAT rate 3 applied to the net line item total. |
| VatRateTwo | string | false | none | The VAT rate 2 applied to the net line item total. |
LineItemsCollection
{
"LineItem": {
"Allocations": {
"Allocation": {
"AllocationAccountCode": "string",
"Custom1": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"IsTestUser": "string",
"Percentage": "string"
}
},
"AllocationStatus": "string",
"AmountWithoutVat": "string",
"ApprovedLineItemAmount": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"DeliverySlipNumber": "string",
"Description": "string",
"ExpenseTypeCode": "string",
"IsMatched": "string",
"LineItemId": "string",
"LineItemIsTestUser": "string",
"MatchedPurchaseOrderLineItemId": "string",
"PurchaseOrderNumber": "string",
"Quantity": "string",
"RequestedLineItemAmount": "string",
"RequestLineItemNumber": "string",
"ShipFromPostalCode": "string",
"ShipToPostalCode": "string",
"SupplierPartId": "string",
"Tax": "string",
"TaxCode": "string",
"TaxCode2": "string",
"TaxCode3": "string",
"TaxCode4": "string",
"TotalPrice": "string",
"UnitOfMeasure": "string",
"UnitPrice": "string",
"VatAmount": "string",
"VatAmountFour": "string",
"VatAmountThree": "string",
"VatAmountTwo": "string",
"VatRate": "string",
"VatRateFour": "string",
"VatRateThree": "string",
"VatRateTwo": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| LineItem | LineItem | false | none | none |
PaymentRequest
{
"AmountWithoutVat": "string",
"ApprovalStatus": "string",
"ApprovedByDelegate": "string",
"AssignedByUsername": "string",
"AssignedDate": "string",
"BuyerCostCenter": "string",
"CalculatedAmount": "string",
"CheckNumber": "string",
"CompanyBillToAddress": {
"Address1": "string",
"Address2": "string",
"Address3": "string",
"City": "string",
"CountryCode": "string",
"Name": "string",
"PostalCode": "string",
"State": "string"
},
"CompanyShipToAddress": {
"Address1": "string",
"Address2": "string",
"Address3": "string",
"City": "string",
"CountryCode": "string",
"Name": "string",
"PostalCode": "string",
"State": "string"
},
"CountryCode": "string",
"CreatedByUsername": "string",
"CurrencyCode": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom21": "string",
"Custom22": "string",
"Custom23": "string",
"Custom24": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"DataSource": "string",
"DeletedDate": "string",
"DeliverySlipNumber": "string",
"Description": "string",
"DiscountPercentage": "string",
"DiscountTerms": "string",
"EmployeeName": "string",
"ExternalPolicyId": "string",
"ExtractDate": "string",
"FirstApprovalDate": "string",
"FirstSubmitDate": "string",
"ID": "string",
"InvoiceAmount": "string",
"InvoiceDate": "string",
"InvoiceNumber": "string",
"InvoiceReceivedDate": "string",
"IsAssigned": "string",
"IsInvoiceConfirmed": "string",
"IsPaymentRequestDeleted": "string",
"IsPaymentRequestDuplicate": "string",
"IsTestTransaction": "string",
"LastSubmitDate": "string",
"LedgerCode": "string",
"LineItems": {
"LineItem": {
"Allocations": {
"Allocation": {
"AllocationAccountCode": "string",
"Custom1": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"IsTestUser": "string",
"Percentage": "string"
}
},
"AllocationStatus": "string",
"AmountWithoutVat": "string",
"ApprovedLineItemAmount": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"DeliverySlipNumber": "string",
"Description": "string",
"ExpenseTypeCode": "string",
"IsMatched": "string",
"LineItemId": "string",
"LineItemIsTestUser": "string",
"MatchedPurchaseOrderLineItemId": "string",
"PurchaseOrderNumber": "string",
"Quantity": "string",
"RequestedLineItemAmount": "string",
"RequestLineItemNumber": "string",
"ShipFromPostalCode": "string",
"ShipToPostalCode": "string",
"SupplierPartId": "string",
"Tax": "string",
"TaxCode": "string",
"TaxCode2": "string",
"TaxCode3": "string",
"TaxCode4": "string",
"TotalPrice": "string",
"UnitOfMeasure": "string",
"UnitPrice": "string",
"VatAmount": "string",
"VatAmountFour": "string",
"VatAmountThree": "string",
"VatAmountTwo": "string",
"VatRate": "string",
"VatRateFour": "string",
"VatRateThree": "string",
"VatRateTwo": "string"
}
},
"LineItemTotalAmount": "string",
"LineItemVatAmount": "string",
"Name": "string",
"NotesToVendor": "string",
"OB10BuyerId": "string",
"OB10TransactionId": "string",
"OrgUnit01": "string",
"OrgUnit02": "string",
"OrgUnit03": "string",
"OrgUnit04": "string",
"OrgUnit05": "string",
"OrgUnit06": "string",
"PaidAmount": "string",
"PaidDate": "string",
"PaymentAdjustmentNotes": "string",
"PaymentDueDate": "string",
"PaymentMethod": "string",
"PaymentRequestCreatedByTestUser": "string",
"PaymentRequestDeletedBy": "string",
"PaymentStatus": "string",
"PaymentTermsDays": "string",
"ProvincialTaxId": "string",
"PurchaseOrderNumber": "string",
"ReceiptConfirmationType": "string",
"ShippingAmount": "string",
"SubmittedByDelegate": "string",
"TaxAmount": "string",
"TaxCode": "string",
"TaxCode2": "string",
"TaxCode3": "string",
"TaxCode4": "string",
"TotalApprovedAmount": "string",
"URI": "string",
"UserCreationDate": "string",
"VatAmountFour": "string",
"VatAmountOne": "string",
"VatAmountThree": "string",
"VatAmountTwo": "string",
"VatRateFour": "string",
"VatRateOne": "string",
"VatRateThree": "string",
"VatRateTwo": "string",
"VendorRemitAddress": {
"Address1": "string",
"Address2": "string",
"Address3": "string",
"City": "string",
"CountryCode": "string",
"DiscountTerms": "string",
"Name": "string",
"PostalCode": "string",
"State": "string"
},
"VendorShipFromAddress": {
"Address1": "string",
"Address2": "string",
"Address3": "string",
"City": "string",
"CountryCode": "string",
"DiscountTerms": "string",
"Name": "string",
"PostalCode": "string",
"State": "string"
},
"VendorTaxId": "string",
"WorkflowCompleteDate": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| AmountWithoutVat | string | false | none | The net amount of the invoice, excluding VAT. |
| ApprovalStatus | string | false | none | A code which indicates the approval status of the payment request. |
| ApprovedByDelegate | string | false | none | Was the Payment Request approved by a delegate. Format: true/false. |
| AssignedByUsername | string | false | none | Username of the assigning employee. |
| AssignedDate | string | false | none | The date the payment request was assigned to the current owner. |
| BuyerCostCenter | string | false | none | The company defined center responsible for the payment request. |
| CalculatedAmount | string | false | none | The sum of all line item amounts plus shipping amount and tax amount for the payment request. |
| CheckNumber | string | false | none | Check number of the payment made to the vendor. |
| CompanyBillToAddress | CompanyAddress | false | none | none |
| CompanyShipToAddress | CompanyAddress | false | none | none |
| CountryCode | string | false | none | The country code. |
| CreatedByUsername | string | false | none | Username of the payment request creator. |
| CurrencyCode | string | false | none | The 3-letter ISO 4217 currency code for the expense report currency. Examples: USD - US dollars; BRL - Brazilian real; CAD - Canadian dollar; CHF - Swiss franc; EUR - Euro; GBO - Pound sterling; HKD - Hong Kong dollar; INR - Indian rupee; MXN - Mexican peso; NOK - Norwegian krone; SEK - Swedish krona. |
| Custom1 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom10 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom11 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom12 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom13 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom14 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom15 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom16 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom17 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom18 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom19 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom2 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom20 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom21 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom22 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom23 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom24 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom3 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom4 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom5 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom6 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom7 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom8 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom9 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| DataSource | string | false | none | A code which indicates the method used to created the Payment Request. Use "GET /invoice/localizeddata" to translate the code into text. |
| DeletedDate | string | false | none | The date the user deleted the payment request. |
| DeliverySlipNumber | string | false | none | The delivery slip number associated with receiving receipt. |
| Description | string | false | none | User entered description of the Payment Request. |
| DiscountPercentage | string | false | none | The discount from the supplier if the discount terms are met. |
| DiscountTerms | string | false | none | The NET discount terms with a supplier when discounts apply. |
| EmployeeName | string | false | none | The owner of the Payment Request. |
| ExternalPolicyId | string | false | none | The external policy ID. |
| ExtractDate | string | false | none | The date the payment request was extracted, in order to import it into an accounts payable system and generate a payment. |
| FirstApprovalDate | string | false | none | The date the payment request received its first approval in its approval workflow. |
| FirstSubmitDate | string | false | none | The date the payment request was first submitted. |
| ID | string | false | none | The unique identifier of the resource. |
| InvoiceAmount | string | false | none | User-entered value representing the total invoice amount, used to calculate amount remaining on the line item page. |
| InvoiceDate | string | false | none | The date the vendor issued the invoice. |
| InvoiceNumber | string | false | none | The invoice Number from the vendor for the payment request. |
| InvoiceReceivedDate | string | false | none | The date on which the invoice was received. |
| IsAssigned | string | false | none | Whether the payment request is assigned. Format: true/false. |
| IsInvoiceConfirmed | string | false | none | Indicates if the payment request invoice is confirmed or in a different status. Format: true/false. |
| IsPaymentRequestDeleted | string | false | none | Whether the payment request is deleted. Format: true/false. |
| IsPaymentRequestDuplicate | string | false | none | Whether the payment request identified as a duplicate of another existing request. Format:true/false. |
| IsTestTransaction | string | false | none | Is the payment request a test transaction (true/false). |
| LastSubmitDate | string | false | none | The date the payment request was last submitted. |
| LedgerCode | string | false | none | A code which indicates which company journal the payment request is assigned to. Use "GET /invoice/localizeddata" to translate the code into text. |
| LineItems | LineItemsCollection | false | none | none |
| LineItemTotalAmount | string | false | none | The sum of all line item amounts. |
| LineItemVatAmount | string | false | none | The sum amount of VAT from all line items in the request. |
| Name | string | false | none | The payment request name. |
| NotesToVendor | string | false | none | Information from the customer to the vendor for special requests or handling for the ordered good or service. |
| OB10BuyerId | string | false | none | A unique buyer account on the OB10 network. |
| OB10TransactionId | string | false | none | Unique identifier for the PR transaction (generated by OB10). |
| OrgUnit01 | string | false | none | The details from the organization unit fields. These may not have data, depending on configuration. |
| OrgUnit02 | string | false | none | The details from the organization unit fields. These may not have data, depending on configuration. |
| OrgUnit03 | string | false | none | The details from the organization unit fields. These may not have data, depending on configuration. |
| OrgUnit04 | string | false | none | The details from the organization unit fields. These may not have data, depending on configuration. |
| OrgUnit05 | string | false | none | The details from the organization unit fields. These may not have data, depending on configuration. |
| OrgUnit06 | string | false | none | The details from the organization unit fields. These may not have data, depending on configuration. |
| PaidAmount | string | false | none | Represents the amount of the payment that will be/has been made for the invoice. |
| PaidDate | string | false | none | The date payment was made to the vendor. |
| PaymentAdjustmentNotes | string | false | none | Notes to the vendor regarding the amount paid (underpayment due to damages, for example). |
| PaymentDueDate | string | false | none | The date the vendor needs to be paid by. |
| PaymentMethod | string | false | none | A code which indicates the method used to reimburse the vendor for the Payment Request. Use "GET /invoice/localizeddata" to translate the code into text. |
| PaymentRequestCreatedByTestUser | string | false | none | Was the Payment Request created by a Test User. Format: true/false. |
| PaymentRequestDeletedBy | string | false | none | The user who deleted the payment request. |
| PaymentStatus | string | false | none | A code which indicates the payment status of the payment request. |
| PaymentTermsDays | string | false | none | This number, along with type of payment terms (example: NET), determine when the invoice is expected to be paid. |
| ProvincialTaxId | string | false | none | The vendor provincial tax ID. |
| PurchaseOrderNumber | string | false | none | The purchase order number for the purchase order associated with the invoice. |
| ReceiptConfirmationType | string | false | none | A code which indicates the receipt confirmation type for this payment request (Invoice Confirmation, for example). Use "GET /invoice/localizeddata" to translate the code into text. |
| ShippingAmount | string | false | none | The value for the shipping amount header field. |
| SubmittedByDelegate | string | false | none | Whether the payment request was created by a delegate. Format: true/false. |
| TaxAmount | string | false | none | The value for the tax amount header field. |
| TaxCode | string | false | none | The tax code assigned for the Request, based on the tax setting. |
| TaxCode2 | string | false | none | The tax code 2 assigned for the request, based on the tax setting. |
| TaxCode3 | string | false | none | The tax code 3 assigned for the request, based on the tax setting. |
| TaxCode4 | string | false | none | The tax code 4 assigned for the request, based on the tax setting. |
| TotalApprovedAmount | string | false | none | The total amount that has been approved. |
| URI | string | false | none | The URI to the resource. |
| UserCreationDate | string | false | none | The date the Concur Invoice user first saved the payment request. |
| VatAmountFour | string | false | none | The amount of VAT included in the invoice total. Fourth of four VAT amount fields available. |
| VatAmountOne | string | false | none | The amount of VAT included in the invoice total. First of four VAT amount fields available. |
| VatAmountThree | string | false | none | The amount of VAT included in the invoice total. Third of four VAT amount fields available. |
| VatAmountTwo | string | false | none | The amount of VAT included in the invoice total. Second of four VAT amount fields available. |
| VatRateFour | string | false | none | The VAT rate applied to the net invoice total. Should relate to the fourth VAT amount field. |
| VatRateOne | string | false | none | The VAT rate applied to the net invoice total. Should relate to the first VAT amount field. |
| VatRateThree | string | false | none | The VAT rate applied to the net invoice total. Should relate to the third VAT amount field. |
| VatRateTwo | string | false | none | The VAT rate applied to the net invoice total. Should relate to the second VAT amount field. |
| VendorRemitAddress | VendorAddress | false | none | none |
| VendorShipFromAddress | VendorAddress | false | none | none |
| VendorTaxId | string | false | none | The vendor tax ID. |
| WorkflowCompleteDate | string | false | none | The date the last step in the workflow process completed. |
PaymentRequestAllocationPostPut
{
"Custom01": "string",
"Custom02": "string",
"Custom03": "string",
"Custom04": "string",
"Custom05": "string",
"Custom06": "string",
"Custom07": "string",
"Custom08": "string",
"Custom09": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"Percentage": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Custom01 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom02 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom03 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom04 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom05 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom06 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom07 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom08 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom09 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom10 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom11 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom12 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom13 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom14 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom15 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom16 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom17 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom18 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom19 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom20 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Percentage | string | false | none | The percentage of the request line item that the individual allocation records. All allocations associated to a given line item should add up to 100. |
PaymentRequestLineItemPost
{
"Allocations": {
"Custom01": "string",
"Custom02": "string",
"Custom03": "string",
"Custom04": "string",
"Custom05": "string",
"Custom06": "string",
"Custom07": "string",
"Custom08": "string",
"Custom09": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"Percentage": "string"
},
"AmountWithoutVat": "string",
"Custom01": "string",
"Custom02": "string",
"Custom03": "string",
"Custom04": "string",
"Custom05": "string",
"Custom06": "string",
"Custom07": "string",
"Custom08": "string",
"Custom09": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"Description": "string",
"ExpenseTypeCode": "string",
"ItemCode": "string",
"PurchaseOrderNumber": "string",
"Quantity": "string",
"ShipFromPostalCode": "string",
"ShipToPostalCode": "string",
"SupplierPartId": "string",
"Tax": "string",
"TaxCode": "string",
"TaxCode2": "string",
"TaxCode3": "string",
"TaxCode4": "string",
"TotalPrice": "string",
"UnitOfMeasure": "string",
"UnitPrice": "string",
"VatAmount": "string",
"VatAmountFour": "string",
"VatAmountThree": "string",
"VatAmountTwo": "string",
"VatRate": "string",
"VatRateFour": "string",
"VatRateThree": "string",
"VatRateTwo": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Allocations | PaymentRequestAllocationPostPut | false | none | none |
| AmountWithoutVat | string | false | none | The net amount of the line item, excluding VAT. |
| Custom01 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom02 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom03 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom04 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom05 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom06 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom07 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom08 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom09 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom10 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom11 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom12 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom13 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom14 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom15 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom16 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom17 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom18 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom19 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom20 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Description | string | false | none | Brief overview of the good or service ordered. |
| ExpenseTypeCode | string | false | none | A code which indicates the expense type for the line item. |
| ItemCode | string | false | none | Represents the item code (the unique code a vendor assigns to a good or code a vendor assigns to a good or service to identify it). |
| PurchaseOrderNumber | string | false | none | Purchase order that is associated to the line item . |
| Quantity | string | false | none | Total number of goods or services ordered. |
| ShipFromPostalCode | string | false | none | The postal code the good or service was shipped from. |
| ShipToPostalCode | string | false | none | The postal code the good or service will be shipped to. |
| SupplierPartId | string | false | none | The unique identifier provided by the supplier that is associated with the good or service. |
| Tax | string | false | none | The tax associated with the line item. |
| TaxCode | string | false | none | The tax code assigned for the line item, based on the tax setting. |
| TaxCode2 | string | false | none | The tax code 2 assigned for the line item, based on the tax setting. |
| TaxCode3 | string | false | none | The tax code 3 assigned for the line item, based on the tax setting. |
| TaxCode4 | string | false | none | The tax code 4 assigned for the line item, based on the tax setting. |
| TotalPrice | string | false | none | The total amount of the line item. |
| UnitOfMeasure | string | false | none | The code for the measurement unit used to quantify the good or service. Use "GET /invoice/localizeddata" to look up codes and descriptions. |
| UnitPrice | string | false | none | The cost for a single unit of the line item good or service. |
| VatAmount | string | false | none | The amount of VAT 1 included in the line item total. |
| VatAmountFour | string | false | none | The amount of VAT 4 included in the line item total. |
| VatAmountThree | string | false | none | The amount of VAT 3 included in the line item total. |
| VatAmountTwo | string | false | none | The amount of VAT 2 included in the line item total. |
| VatRate | string | false | none | The VAT rate 1 applied to the net line item total. |
| VatRateFour | string | false | none | The VAT rate 4 applied to the net line item total. |
| VatRateThree | string | false | none | The VAT rate 3 applied to the net line item total. |
| VatRateTwo | string | false | none | The VAT rate 2 applied to the net line item total. |
PaymentRequestLineItemPut
{
"Action": "string",
"Allocations": {
"Custom01": "string",
"Custom02": "string",
"Custom03": "string",
"Custom04": "string",
"Custom05": "string",
"Custom06": "string",
"Custom07": "string",
"Custom08": "string",
"Custom09": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"Percentage": "string"
},
"AmountWithoutVat": "string",
"Custom01": "string",
"Custom02": "string",
"Custom03": "string",
"Custom04": "string",
"Custom05": "string",
"Custom06": "string",
"Custom07": "string",
"Custom08": "string",
"Custom09": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"Description": "string",
"ExpenseTypeCode": "string",
"ItemCode": "string",
"LineItemID": "string",
"PurchaseOrderNumber": "string",
"Quantity": "string",
"ShipFromPostalCode": "string",
"ShipToPostalCode": "string",
"SupplierPartId": "string",
"Tax": "string",
"TaxCode": "string",
"TaxCode2": "string",
"TaxCode3": "string",
"TaxCode4": "string",
"UnitOfMeasure": "string",
"UnitPrice": "string",
"VatAmount": "string",
"VatAmountFour": "string",
"VatAmountThree": "string",
"VatAmountTwo": "string",
"VatRate": "string",
"VatRateFour": "string",
"VatRateThree": "string",
"VatRateTwo": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Action | string | false | none | The operation(INSERT/UPDATE/DELETE) to be performed on the line item. |
| Allocations | PaymentRequestAllocationPostPut | false | none | none |
| AmountWithoutVat | string | false | none | The net amount of the line item, excluding VAT. |
| Custom01 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom02 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom03 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom04 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom05 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom06 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom07 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom08 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom09 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom10 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom11 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom12 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom13 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom14 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom15 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom16 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom17 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom18 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom19 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom20 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Description | string | false | none | Brief overview of the good or service ordered. |
| ExpenseTypeCode | string | false | none | A code which indicates the expense type for the line item. |
| ItemCode | string | false | none | Represents the item code (the unique code a vendor assigns to a good or code a vendor assigns to a good or service to identify it). |
| LineItemID | string | false | none | Line item ID of the payment request. |
| PurchaseOrderNumber | string | false | none | Purchase order that is associated to the line item . |
| Quantity | string | false | none | Total number of goods or services ordered. |
| ShipFromPostalCode | string | false | none | The postal code the good or service was shipped from. |
| ShipToPostalCode | string | false | none | The postal code the good or service will be shipped to. |
| SupplierPartId | string | false | none | The unique identifier provided by the supplier that is associated with the good or service. |
| Tax | string | false | none | The tax associated with the line item. |
| TaxCode | string | false | none | The tax code 1 assigned for the line item, based on the tax setting. |
| TaxCode2 | string | false | none | The tax code 2 assigned for the line item, based on the tax setting. |
| TaxCode3 | string | false | none | The tax code 3 assigned for the line item, based on the tax setting. |
| TaxCode4 | string | false | none | The tax code 4 assigned for the line item, based on the tax setting. |
| UnitOfMeasure | string | false | none | The code for the measurement unit used to quantify the good or service. Use "GET /invoice/localizeddata" to look up codes and descriptions. |
| UnitPrice | string | false | none | The cost for a single unit of the line item good or service. |
| VatAmount | string | false | none | The amount of VAT 1 included in the line item total. |
| VatAmountFour | string | false | none | The amount of VAT 4 included in the line item total. |
| VatAmountThree | string | false | none | The amount of VAT 3 included in the line item total. |
| VatAmountTwo | string | false | none | The amount of VAT 2 included in the line item total. |
| VatRate | string | false | none | The VAT rate 1 applied to the net line item total. |
| VatRateFour | string | false | none | The VAT rate 4 applied to the net line item total. |
| VatRateThree | string | false | none | The VAT rate 3 applied to the net line item total. |
| VatRateTwo | string | false | none | The VAT rate 2 applied to the net line item total. |
PaymentRequestPost
{
"AmountWithoutVat": "string",
"BuyerCostCenter": "string",
"CheckNumber": "string",
"CompanyBillToAddressCode": "string",
"CompanyShipToAddressCode": "string",
"CountryCode": "string",
"CurrencyCode": "string",
"Custom01": "string",
"Custom02": "string",
"Custom03": "string",
"Custom04": "string",
"Custom05": "string",
"Custom06": "string",
"Custom07": "string",
"Custom08": "string",
"Custom09": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"Custom21": "string",
"Custom22": "string",
"Custom23": "string",
"Custom24": "string",
"DataSource": "string",
"DeliverySlipNumber": "string",
"Description": "string",
"DiscountPercentage": "string",
"DiscountTerms": "string",
"EmployeeEmailAddress": "string",
"EmployeeId": "string",
"EmployeeLoginId": "string",
"ExternalPolicyId": "string",
"InvoiceAmount": "string",
"InvoiceDate": "string",
"InvoiceNumber": "string",
"InvoiceReceivedDate": "string",
"IsEmergencyCheckRun": "string",
"IsInvoiceConfirmed": "string",
"LedgerCode": "string",
"LineItems": {
"Allocations": {
"Custom01": "string",
"Custom02": "string",
"Custom03": "string",
"Custom04": "string",
"Custom05": "string",
"Custom06": "string",
"Custom07": "string",
"Custom08": "string",
"Custom09": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"Percentage": "string"
},
"AmountWithoutVat": "string",
"Custom01": "string",
"Custom02": "string",
"Custom03": "string",
"Custom04": "string",
"Custom05": "string",
"Custom06": "string",
"Custom07": "string",
"Custom08": "string",
"Custom09": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"Description": "string",
"ExpenseTypeCode": "string",
"ItemCode": "string",
"PurchaseOrderNumber": "string",
"Quantity": "string",
"ShipFromPostalCode": "string",
"ShipToPostalCode": "string",
"SupplierPartId": "string",
"Tax": "string",
"TaxCode": "string",
"TaxCode2": "string",
"TaxCode3": "string",
"TaxCode4": "string",
"TotalPrice": "string",
"UnitOfMeasure": "string",
"UnitPrice": "string",
"VatAmount": "string",
"VatAmountFour": "string",
"VatAmountThree": "string",
"VatAmountTwo": "string",
"VatRate": "string",
"VatRateFour": "string",
"VatRateThree": "string",
"VatRateTwo": "string"
},
"Name": "string",
"NotesToVendor": "string",
"OB10BuyerId": "string",
"OB10TransactionId": "string",
"OrgUnit01": "string",
"OrgUnit02": "string",
"OrgUnit03": "string",
"OrgUnit04": "string",
"OrgUnit05": "string",
"OrgUnit06": "string",
"PaymentAdjustmentNotes": "string",
"PaymentAmount": "string",
"PaymentDueDate": "string",
"PaymentTermsDays": "string",
"ProvincialTaxId": "string",
"PurchaseOrderId": "string",
"ReceiptConfirmationType": "string",
"ShippingAmount": "string",
"TaxAmount": "string",
"VatAmountFour": "string",
"VatAmountOne": "string",
"VatAmountThree": "string",
"VatAmountTwo": "string",
"VatRateFour": "string",
"VatRateOne": "string",
"VatRateThree": "string",
"VatRateTwo": "string",
"VendorRemitToIdentifier": {
"Address1": "string",
"AddressCode": "string",
"Name": "string",
"PostalCode": "string",
"VendorCode": "string"
},
"VendorShipFromAddressCode": "string",
"VendorTaxId": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| AmountWithoutVat | string | false | none | The net amount of the invoice, excluding VAT. |
| BuyerCostCenter | string | false | none | The company defined center responsible for the payment request. |
| CheckNumber | string | false | none | Check number of the payment made to the vendor. |
| CompanyBillToAddressCode | string | false | none | The code which identifies the company location to which the vendor billed the invoice. |
| CompanyShipToAddressCode | string | false | none | The code which identifies the company location to which the vendor shipped items listed in the invoice. |
| CountryCode | string | false | none | The country code. |
| CurrencyCode | string | false | none | The 3-letter ISO 4217 currency code for the expense report currency. Examples: USD - US dollars; BRL - Brazilian real; CAD - Canadian dollar; CHF - Swiss franc; EUR - Euro; GBO - Pound sterling; HKD - Hong Kong dollar; INR - Indian rupee; MXN - Mexican peso; NOK - Norwegian krone; SEK - Swedish krona. |
| Custom01 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom02 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom03 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom04 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom05 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom06 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom07 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom08 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom09 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom10 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom11 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom12 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom13 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom14 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom15 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom16 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom17 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom18 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom19 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom20 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom21 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom22 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom23 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom24 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| DataSource | string | false | none | A code which indicates the method used to created the payment request. Use "GET /invoice/localizeddata" to translate the code into text. |
| DeliverySlipNumber | string | false | none | The delivery slip number associated with receiving receipt. |
| Description | string | false | none | User entered description of the payment request. |
| DiscountPercentage | string | false | none | The discount from the supplier if the discount terms are met. |
| DiscountTerms | string | false | none | The NET discount terms with a supplier when discounts apply. |
| EmployeeEmailAddress | string | false | none | The email address of the employee to whom the request should be assigned. Not evaluated if EmployeeLoginId or EmployeeId match an employee. This value is required if none of the following are provided: LedgerCode, EmployeeLoginId, EmployeeId; PurchaseOrderNumber; ExternalPolicyId. |
| EmployeeId | string | false | none | The company ID of the employee to whom the request should be assigned. Has precedence over EmployeeEmail; not evaluated if EmployeeLoginId matches an employee. This value is required if none of the following are provided: LedgerCode, EmployeeLoginId; EmployeeEmail; PurchaseOrderNumber; ExternalPolicyId. |
| EmployeeLoginId | string | false | none | The login ID of the employee to whom the request should be assigned. Has precedence over EmployeeId and EmployeeEmail. This value is required if none of the following are provided: LedgerCode, EmployeeId; EmployeeEmail; PurchaseOrderNumber; ExternalPolicyId. |
| ExternalPolicyId | string | false | none | The external policy ID of the Payment Request. This value is required if none of the following are provided: LedgerCode, EmployeeLoginId, EmployeeId; EmployeeEmail; PurchaseOrderNumber. |
| InvoiceAmount | string | false | none | User-entered value representing the total invoice amount, used to calculate amount remaining on the line item page. |
| InvoiceDate | string | false | none | The date the vendor issued the invoice. |
| InvoiceNumber | string | false | none | The invoice number from the vendor for the payment request. |
| InvoiceReceivedDate | string | false | none | The date on which the invoice was received. |
| IsEmergencyCheckRun | string | false | none | Is an emergency check run required. Format: Y/N |
| IsInvoiceConfirmed | string | false | none | Indicates if the Payment Request Invoice is confirmed or in a different status. Format: true/false. |
| LedgerCode | string | false | none | A code which indicates which company journal the Payment Request is assigned to. Use "GET /invoice/localizeddata" to obtain valid codes. This value is required if none of the following are provided: EmployeeLoginId; EmployeeId; EmployeeEmail; PurchaseOrderNumber; ExternalPolicyId. |
| LineItems | PaymentRequestLineItemPost | false | none | none |
| Name | string | false | none | The Payment Request Name. |
| NotesToVendor | string | false | none | Information from the customer to the vendor for special requests or handling for the ordered good or service. |
| OB10BuyerId | string | false | none | A unique buyer account on the OB10 network. |
| OB10TransactionId | string | false | none | Unique Identifier for the PR transaction (generated by OB10). |
| OrgUnit01 | string | false | none | The details from the organization unit fields. These may not have data, depending on configuration. |
| OrgUnit02 | string | false | none | The details from the organization unit fields. These may not have data, depending on configuration. |
| OrgUnit03 | string | false | none | The details from the organization unit fields. These may not have data, depending on configuration. |
| OrgUnit04 | string | false | none | The details from the organization unit fields. These may not have data, depending on configuration. |
| OrgUnit05 | string | false | none | The details from the organization unit fields. These may not have data, depending on configuration. |
| OrgUnit06 | string | false | none | The details from the organization unit fields. These may not have data, depending on configuration. |
| PaymentAdjustmentNotes | string | false | none | Notes to the vendor regarding the amount paid (underpayment due to damages, for example). |
| PaymentAmount | string | false | none | Represents the amount of the payment that will be/has been made for the invoice. |
| PaymentDueDate | string | false | none | The date the vendor needs to be paid by. |
| PaymentTermsDays | string | false | none | This number, along with type of payment terms (example: NET), determine when the invoice is expected to be paid. |
| ProvincialTaxId | string | false | none | The vendor provincial tax ID. |
| PurchaseOrderId | string | false | none | The ID of the Purchase Order to which the Payment Request should be matched. This value is required if none of the following are provided: LedgerCode, EmployeeLoginId, EmployeeId; EmployeeEmail; ExternalPolicyId. |
| ReceiptConfirmationType | string | false | none | A code which indicates the receipt confirmation type for this Payment Request (Invoice Confirmation, for example). Use "GET /invoice/localizeddata" to translate the code into text. |
| ShippingAmount | string | false | none | The value for the Shipping Amount header field. |
| TaxAmount | string | false | none | The value for the Tax Amount header field. |
| VatAmountFour | string | false | none | The amount of VAT included in the invoice total. Fourth of four VAT amount fields available. |
| VatAmountOne | string | false | none | The amount of VAT included in the invoice total. First of four VAT amount fields available. |
| VatAmountThree | string | false | none | The amount of VAT included in the invoice total. Third of four VAT amount fields available. |
| VatAmountTwo | string | false | none | The amount of VAT included in the invoice total. Second of four VAT amount fields available. |
| VatRateFour | string | false | none | The VAT rate applied to the net invoice total. Should relate to the fourth VAT amount field. |
| VatRateOne | string | false | none | The VAT rate applied to the net invoice total. Should relate to the first VAT amount field. |
| VatRateThree | string | false | none | The VAT rate applied to the net invoice total. Should relate to the third VAT amount field. |
| VatRateTwo | string | false | none | The VAT rate applied to the net invoice total. Should relate to the second VAT amount field. |
| VendorRemitToIdentifier | VendorIdentifier | false | none | none |
| VendorShipFromAddressCode | string | false | none | The code which identifies the location from which the vendor shipped items listed in the invoice. |
| VendorTaxId | string | false | none | The vendor tax ID. |
PaymentRequestPut
{
"AmountWithoutVat": "string",
"BuyerCostCenter": "string",
"CheckNumber": "string",
"CompanyBillToAddressCode": "string",
"CompanyShipToAddressCode": "string",
"CountryCode": "string",
"CurrencyCode": "string",
"Custom01": "string",
"Custom02": "string",
"Custom03": "string",
"Custom04": "string",
"Custom05": "string",
"Custom06": "string",
"Custom07": "string",
"Custom08": "string",
"Custom09": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"Custom21": "string",
"Custom22": "string",
"Custom23": "string",
"Custom24": "string",
"DeliverySlipNumber": "string",
"Description": "string",
"DiscountPercentage": "string",
"DiscountTerms": "string",
"DoCopyDown": "string",
"DoCopyDownFromPO": "string",
"EmployeeEmailAddress": "string",
"EmployeeId": "string",
"EmployeeLoginId": "string",
"InvoiceAmount": "string",
"InvoiceDate": "string",
"InvoiceNumber": "string",
"InvoiceReceivedDate": "string",
"IsEmergencyCheckRun": "string",
"IsInvoiceConfirmed": "string",
"LineItems": {
"Action": "string",
"Allocations": {
"Custom01": "string",
"Custom02": "string",
"Custom03": "string",
"Custom04": "string",
"Custom05": "string",
"Custom06": "string",
"Custom07": "string",
"Custom08": "string",
"Custom09": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"Percentage": "string"
},
"AmountWithoutVat": "string",
"Custom01": "string",
"Custom02": "string",
"Custom03": "string",
"Custom04": "string",
"Custom05": "string",
"Custom06": "string",
"Custom07": "string",
"Custom08": "string",
"Custom09": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"Description": "string",
"ExpenseTypeCode": "string",
"ItemCode": "string",
"LineItemID": "string",
"PurchaseOrderNumber": "string",
"Quantity": "string",
"ShipFromPostalCode": "string",
"ShipToPostalCode": "string",
"SupplierPartId": "string",
"Tax": "string",
"TaxCode": "string",
"TaxCode2": "string",
"TaxCode3": "string",
"TaxCode4": "string",
"UnitOfMeasure": "string",
"UnitPrice": "string",
"VatAmount": "string",
"VatAmountFour": "string",
"VatAmountThree": "string",
"VatAmountTwo": "string",
"VatRate": "string",
"VatRateFour": "string",
"VatRateThree": "string",
"VatRateTwo": "string"
},
"Name": "string",
"NotesToVendor": "string",
"OB10BuyerId": "string",
"OB10TransactionId": "string",
"OrgUnit01": "string",
"OrgUnit02": "string",
"OrgUnit03": "string",
"OrgUnit04": "string",
"OrgUnit05": "string",
"OrgUnit06": "string",
"PaymentAdjustmentNotes": "string",
"PaymentAmount": "string",
"PaymentDueDate": "string",
"PaymentTermsDays": "string",
"ProvincialTaxId": "string",
"PurchaseOrderId": "string",
"ReceiptConfirmationType": "string",
"RequestID": "string",
"ShippingAmount": "string",
"TaxAmount": "string",
"VatAmountFour": "string",
"VatAmountOne": "string",
"VatAmountThree": "string",
"VatAmountTwo": "string",
"VatRateFour": "string",
"VatRateOne": "string",
"VatRateThree": "string",
"VatRateTwo": "string",
"VendorRemitToIdentifier": {
"Address1": "string",
"AddressCode": "string",
"Name": "string",
"PostalCode": "string",
"VendorCode": "string"
},
"VendorShipFromAddressCode": "string",
"VendorTaxId": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| AmountWithoutVat | string | false | none | The net amount of the invoice, excluding VAT. |
| BuyerCostCenter | string | false | none | The company defined center responsible for the payment request. |
| CheckNumber | string | false | none | Check number of the payment made to the vendor. |
| CompanyBillToAddressCode | string | false | none | The code which identifies the company location to which the vendor billed the invoice. |
| CompanyShipToAddressCode | string | false | none | The code which identifies the company location to which the vendor shipped items listed in the invoice. |
| CountryCode | string | false | none | The country code. |
| CurrencyCode | string | false | none | The 3-letter ISO 4217 currency code for the expense report currency. Examples: USD - US dollars; BRL - Brazilian real; CAD - Canadian dollar; CHF - Swiss franc; EUR - Euro; GBO - Pound sterling; HKD - Hong Kong dollar; INR - Indian rupee; MXN - Mexican peso; NOK - Norwegian krone; SEK - Swedish krona. |
| Custom01 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom02 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom03 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom04 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom05 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom06 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom07 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom08 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom09 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom10 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom11 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom12 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom13 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom14 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom15 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom16 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom17 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom18 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom19 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom20 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom21 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom22 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom23 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| Custom24 | string | false | none | The details from the custom fields. These may not have data, depending on configuration. |
| DeliverySlipNumber | string | false | none | The delivery slip number associated with receiving receipt. |
| Description | string | false | none | User entered description of the payment request. |
| DiscountPercentage | string | false | none | The discount from the supplier if the discount terms are met. |
| DiscountTerms | string | false | none | The NET discount terms with a supplier when discounts apply. |
| DoCopyDown | string | false | none | Use new request owner's employee copydown values in this request |
| DoCopyDownFromPO | string | false | none | Use purchase order copydown values in this request |
| EmployeeEmailAddress | string | false | none | The email address of the employee to whom the request should be assigned. Not evaluated if EmployeeLoginId or EmployeeId match an employee. |
| EmployeeId | string | false | none | The company ID of the employee to whom the request should be assigned. Has precedence over EmployeeEmail; not evaluated if EmployeeLoginId matches an employee. |
| EmployeeLoginId | string | false | none | The login ID of the employee to whom the request should be assigned. Has precedence over EmployeeId and EmployeeEmail. |
| InvoiceAmount | string | false | none | User-entered value representing the total invoice amount, used to calculate amount remaining on the line item page. |
| InvoiceDate | string | false | none | The date the vendor issued the invoice. |
| InvoiceNumber | string | false | none | The invoice number from the vendor for the payment request. |
| InvoiceReceivedDate | string | false | none | The date on which the invoice was received. |
| IsEmergencyCheckRun | string | false | none | Is an emergency check run required. Format: Y/N. |
| IsInvoiceConfirmed | string | false | none | Indicates if the payment request invoice is confirmed or in a different status. Format: true/false. |
| LineItems | PaymentRequestLineItemPut | false | none | none |
| Name | string | false | none | The payment request name. |
| NotesToVendor | string | false | none | Information from the customer to the vendor for special requests or handling for the ordered good or service. |
| OB10BuyerId | string | false | none | A unique buyer account on the OB10 network. |
| OB10TransactionId | string | false | none | Unique identifier for the PR transaction (generated by OB10). |
| OrgUnit01 | string | false | none | The details from the organization unit fields. These may not have data, depending on configuration. |
| OrgUnit02 | string | false | none | The details from the organization unit fields. These may not have data, depending on configuration. |
| OrgUnit03 | string | false | none | The details from the organization unit fields. These may not have data, depending on configuration. |
| OrgUnit04 | string | false | none | The details from the organization unit fields. These may not have data, depending on configuration. |
| OrgUnit05 | string | false | none | The details from the organization unit fields. These may not have data, depending on configuration. |
| OrgUnit06 | string | false | none | The details from the organization unit fields. These may not have data, depending on configuration. |
| PaymentAdjustmentNotes | string | false | none | Notes to the vendor regarding the amount paid (underpayment due to damages, for example). |
| PaymentAmount | string | false | none | Represents the amount of the payment that will be/has been made for the Invoice. |
| PaymentDueDate | string | false | none | The date the vendor needs to be paid by. |
| PaymentTermsDays | string | false | none | This number, along with type of payment terms (example: NET), determine when the invoice is expected to be paid. |
| ProvincialTaxId | string | false | none | The vendor provincial tax ID. |
| PurchaseOrderId | string | false | none | The ID of the purchase order to which the payment request should be matched. |
| ReceiptConfirmationType | string | false | none | A code which indicates the receipt confirmation type for this payment request (Invoice Confirmation, for example). Use "GET /invoice/localizeddata" to translate the code into text. |
| RequestID | string | false | none | The request ID of the payment request |
| ShippingAmount | string | false | none | The value for the shipping s amount header field. |
| TaxAmount | string | false | none | The value for the tax amount header field. |
| VatAmountFour | string | false | none | The amount of VAT included in the invoice total. Fourth of four VAT amount fields available. |
| VatAmountOne | string | false | none | The amount of VAT included in the invoice total. First of four VAT amount fields available. |
| VatAmountThree | string | false | none | The amount of VAT included in the invoice total. Third of four VAT amount fields available. |
| VatAmountTwo | string | false | none | The amount of VAT included in the invoice total. Second of four VAT amount fields available. |
| VatRateFour | string | false | none | The VAT rate applied to the net invoice total. Should relate to the fourth VAT amount field. |
| VatRateOne | string | false | none | The VAT rate applied to the net invoice total. Should relate to the first VAT amount field. |
| VatRateThree | string | false | none | The VAT rate applied to the net invoice total. Should relate to the third VAT amount field. |
| VatRateTwo | string | false | none | The VAT rate applied to the net invoice total. Should relate to the second VAT amount field. |
| VendorRemitToIdentifier | VendorIdentifier | false | none | none |
| VendorShipFromAddressCode | string | false | none | The code which identifies the location from which the vendor shipped items listed in the invoice. |
| VendorTaxId | string | false | none | The vendor tax ID. |
VendorAddress
{
"Address1": "string",
"Address2": "string",
"Address3": "string",
"City": "string",
"CountryCode": "string",
"DiscountTerms": "string",
"Name": "string",
"PostalCode": "string",
"State": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Address1 | string | false | none | Line 1 of the street address. |
| Address2 | string | false | none | Line 2 of the street address |
| Address3 | string | false | none | Line 3 of the street address |
| City | string | false | none | The name of the city. |
| CountryCode | string | false | none | The country code. |
| DiscountTerms | string | false | none | The NET discount terms with a supplier when discounts apply. |
| Name | string | false | none | The name of the vendor. |
| PostalCode | string | false | none | The postal / zip code. |
| State | string | false | none | The state code. |
VendorIdentifier
{
"Address1": "string",
"AddressCode": "string",
"Name": "string",
"PostalCode": "string",
"VendorCode": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Address1 | string | false | none | Line 1 of the street address. |
| AddressCode | string | false | none | The code which identifies a particular vendor location. |
| Name | string | false | none | The name of the vendor. |
| PostalCode | string | false | none | The postal / zip code. |
| VendorCode | string | false | none | The code which identifies a particular vendor. |
Void
{}
Properties
None
Payment Request Digest v3.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
A payment request digest is a collection of summarized payment requests to invoice vendors. This API provides methods to view all payment requests corresponding to search parameters, or view a payment request digest by ID.
Base URLs:
Resources
get_invoice_paymentrequestdigests{id}
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/invoice/paymentrequestdigests/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://www.concursolutions.com/api/v3.0/invoice/paymentrequestdigests/{id} HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/invoice/paymentrequestdigests/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/invoice/paymentrequestdigests/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/invoice/paymentrequestdigests/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/invoice/paymentrequestdigests/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/invoice/paymentrequestdigests/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/invoice/paymentrequestdigests/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /invoice/paymentrequestdigests/{id}
Get payment request digest
Returns the specified payment request digest.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The payment request ID |
Example responses
200 Response
{
"ApprovalStatusCode": "string",
"CreateDate": "string",
"CurrencyCode": "string",
"ID": "string",
"InvoiceNumber": "string",
"IsDeleted": "string",
"OwnerLoginID": "string",
"OwnerName": "string",
"PaidDate": "string",
"PaymentRequestId": "string",
"PaymentRequestUri": "string",
"PaymentStatusCode": "string",
"PurchaseOrderNumber": "string",
"Total": "string",
"URI": "string",
"UserDefinedDate": "string",
"VendorName": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<PaymentRequestDigest>
<ApprovalStatusCode>string</ApprovalStatusCode>
<CreateDate>string</CreateDate>
<CurrencyCode>string</CurrencyCode>
<ID>string</ID>
<InvoiceNumber>string</InvoiceNumber>
<IsDeleted>string</IsDeleted>
<OwnerLoginID>string</OwnerLoginID>
<OwnerName>string</OwnerName>
<PaidDate>string</PaidDate>
<PaymentRequestId>string</PaymentRequestId>
<PaymentRequestUri>string</PaymentRequestUri>
<PaymentStatusCode>string</PaymentStatusCode>
<PurchaseOrderNumber>string</PurchaseOrderNumber>
<Total>string</Total>
<URI>string</URI>
<UserDefinedDate>string</UserDefinedDate>
<VendorName>string</VendorName>
</PaymentRequestDigest>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | PaymentRequestDigest |
get__invoice_paymentrequestdigests
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/invoice/paymentrequestdigests \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://www.concursolutions.com/api/v3.0/invoice/paymentrequestdigests HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/invoice/paymentrequestdigests',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/invoice/paymentrequestdigests',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/invoice/paymentrequestdigests', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/invoice/paymentrequestdigests', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/invoice/paymentrequestdigests");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/invoice/paymentrequestdigests", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /invoice/paymentrequestdigests
Get all payment requests digests
Returns all payment requests digests based on the search criteria.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| offset | query | string | false | The start of the page offset. |
| limit | query | integer(int32) | false | The number of records to return (default 1000). |
| approvalStatus | query | string | false | A code representing a payment request approval status. Use "GET /invoice/localizeddata" to get the available approval status codes. |
| paymentStatus | query | string | false | A code representing a Payment Request Payment Status. Use "GET /invoice/localizeddata" to get the available payment status codes |
| vendorInvoiceNumber | query | string | false | Vendor invoice number tied to invoice. |
| createDateBefore | query | string(date-time) | false | The payment request create date is before this date. Format: YYYY-MM-DD |
| createDateAfter | query | string(date-time) | false | The payment request create date is after this date. Format: YYYY-MM-DD |
| userDefinedDateBefore | query | string(date-time) | false | The payment request user defined date is before this date. Format: YYYY-MM-DD |
| userDefinedDateAfter | query | string(date-time) | false | The payment request user defined date is after this date. Format: YYYY-MM-DD |
| submitDateBefore | query | string(date-time) | false | The payment request submit date is before this date. Format: YYYY-MM-DD |
| submitDateAfter | query | string(date-time) | false | The payment request submit date is after this date. Format: YYYY-MM-DD |
| paidDateBefore | query | string(date-time) | false | The payment request paid date is before this date. Format: YYYY-MM-DD |
| paidDateAfter | query | string(date-time) | false | The payment request paid date is after this date. Format: YYYY-MM-DD |
Example responses
200 Response
{
"Items": {
"ApprovalStatusCode": "string",
"CreateDate": "string",
"CurrencyCode": "string",
"ID": "string",
"InvoiceNumber": "string",
"IsDeleted": "string",
"OwnerLoginID": "string",
"OwnerName": "string",
"PaidDate": "string",
"PaymentRequestId": "string",
"PaymentRequestUri": "string",
"PaymentStatusCode": "string",
"PurchaseOrderNumber": "string",
"Total": "string",
"URI": "string",
"UserDefinedDate": "string",
"VendorName": "string"
},
"NextPage": "string",
"PaymentRequestDigest": {
"ApprovalStatusCode": "string",
"CreateDate": "string",
"CurrencyCode": "string",
"ID": "string",
"InvoiceNumber": "string",
"IsDeleted": "string",
"OwnerLoginID": "string",
"OwnerName": "string",
"PaidDate": "string",
"PaymentRequestId": "string",
"PaymentRequestUri": "string",
"PaymentStatusCode": "string",
"PurchaseOrderNumber": "string",
"Total": "string",
"URI": "string",
"UserDefinedDate": "string",
"VendorName": "string"
},
"TotalCount": 0
}
<?xml version="1.0" encoding="UTF-8" ?>
<PaymentRequestDigestCollection>
<Items>
<ApprovalStatusCode>string</ApprovalStatusCode>
<CreateDate>string</CreateDate>
<CurrencyCode>string</CurrencyCode>
<ID>string</ID>
<InvoiceNumber>string</InvoiceNumber>
<IsDeleted>string</IsDeleted>
<OwnerLoginID>string</OwnerLoginID>
<OwnerName>string</OwnerName>
<PaidDate>string</PaidDate>
<PaymentRequestId>string</PaymentRequestId>
<PaymentRequestUri>string</PaymentRequestUri>
<PaymentStatusCode>string</PaymentStatusCode>
<PurchaseOrderNumber>string</PurchaseOrderNumber>
<Total>string</Total>
<URI>string</URI>
<UserDefinedDate>string</UserDefinedDate>
<VendorName>string</VendorName>
</Items>
<NextPage>string</NextPage>
<PaymentRequestDigest>
<ApprovalStatusCode>string</ApprovalStatusCode>
<CreateDate>string</CreateDate>
<CurrencyCode>string</CurrencyCode>
<ID>string</ID>
<InvoiceNumber>string</InvoiceNumber>
<IsDeleted>string</IsDeleted>
<OwnerLoginID>string</OwnerLoginID>
<OwnerName>string</OwnerName>
<PaidDate>string</PaidDate>
<PaymentRequestId>string</PaymentRequestId>
<PaymentRequestUri>string</PaymentRequestUri>
<PaymentStatusCode>string</PaymentStatusCode>
<PurchaseOrderNumber>string</PurchaseOrderNumber>
<Total>string</Total>
<URI>string</URI>
<UserDefinedDate>string</UserDefinedDate>
<VendorName>string</VendorName>
</PaymentRequestDigest>
<TotalCount>0</TotalCount>
</PaymentRequestDigestCollection>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | PaymentRequestDigestCollection |
Schemas
PaymentRequestDigest
{
"ApprovalStatusCode": "string",
"CreateDate": "string",
"CurrencyCode": "string",
"ID": "string",
"InvoiceNumber": "string",
"IsDeleted": "string",
"OwnerLoginID": "string",
"OwnerName": "string",
"PaidDate": "string",
"PaymentRequestId": "string",
"PaymentRequestUri": "string",
"PaymentStatusCode": "string",
"PurchaseOrderNumber": "string",
"Total": "string",
"URI": "string",
"UserDefinedDate": "string",
"VendorName": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ApprovalStatusCode | string | false | none | A code indicating the request's approval status. |
| CreateDate | string | false | none | The date the request was created. |
| CurrencyCode | string | false | none | The 3-letter ISO 4217 currency code for the request currency. Examples: USD - US dollars; BRL - Brazilian real; CAD - Canadian dollar; CHF - Swiss franc; EUR - Euro; GBO - Pound sterling; HKD - Hong Kong dollar; INR - Indian rupee; MXN - Mexican peso; NOK - Norwegian krone; SEK - Swedish krona. |
| ID | string | false | none | The unique identifier of the resource. |
| InvoiceNumber | string | false | none | The invoice number of the payment request. |
| IsDeleted | string | false | none | A true/false value which indicates whether the request has been deleted. Deleted requests are retained in the system for historical purposes. |
| OwnerLoginID | string | false | none | The login ID of the payment request owner. |
| OwnerName | string | false | none | The name of the payment request owner. |
| PaidDate | string | false | none | The date when all journal entries in the request were integrated with or extracted to the financial system. |
| PaymentRequestId | string | false | none | The unique identifier of the payment request summarized in this digest. |
| PaymentRequestUri | string | false | none | The URI of the payment request summarized in this digest. |
| PaymentStatusCode | string | false | none | A code indicating the request's payment status. |
| PurchaseOrderNumber | string | false | none | The purchase order number for the purchase order associated with the invoice. |
| Total | string | false | none | The total amount of the request. |
| URI | string | false | none | The URI to the resource. |
| UserDefinedDate | string | false | none | The invoice date as assigned by the user. |
| VendorName | string | false | none | The name of the vendor. |
PaymentRequestDigestCollection
{
"Items": {
"ApprovalStatusCode": "string",
"CreateDate": "string",
"CurrencyCode": "string",
"ID": "string",
"InvoiceNumber": "string",
"IsDeleted": "string",
"OwnerLoginID": "string",
"OwnerName": "string",
"PaidDate": "string",
"PaymentRequestId": "string",
"PaymentRequestUri": "string",
"PaymentStatusCode": "string",
"PurchaseOrderNumber": "string",
"Total": "string",
"URI": "string",
"UserDefinedDate": "string",
"VendorName": "string"
},
"NextPage": "string",
"PaymentRequestDigest": {
"ApprovalStatusCode": "string",
"CreateDate": "string",
"CurrencyCode": "string",
"ID": "string",
"InvoiceNumber": "string",
"IsDeleted": "string",
"OwnerLoginID": "string",
"OwnerName": "string",
"PaidDate": "string",
"PaymentRequestId": "string",
"PaymentRequestUri": "string",
"PaymentStatusCode": "string",
"PurchaseOrderNumber": "string",
"Total": "string",
"URI": "string",
"UserDefinedDate": "string",
"VendorName": "string"
},
"TotalCount": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Items | PaymentRequestDigest | false | none | none |
| NextPage | string | false | none | The URI of the next page of results, if any. |
| PaymentRequestDigest | PaymentRequestDigest | false | none | none |
| TotalCount | integer(int32) | false | none | none |
Purchase Order Receipts v3.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Purchase order receipts are records that the purchase order was completed. This API provides methods to create a new purchase order receipt, view or update an existing purchase order receipt, or delete a purchase order receipt.
Base URLs:
Resources
put__invoice_purchaseorderreceipts
Code samples
# You can also use wget
curl -X PUT https://www.concursolutions.com/api/v3.0/invoice/purchaseorderreceipts \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
PUT https://www.concursolutions.com/api/v3.0/invoice/purchaseorderreceipts HTTP/1.1
Host: www.concursolutions.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"Custom1": "string",
"Custom10": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Deleted": "string",
"DeliverySlipNumber": "string",
"GoodsReceiptNumber": "string",
"ID": "string",
"LineItemExternalID": "string",
"PurchaseOrderNumber": "string",
"ReceivedDate": "string",
"ReceivedQuantity": "string",
"UnitOfMeasureCode": "string",
"URI": "string",
"Version": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://www.concursolutions.com/api/v3.0/invoice/purchaseorderreceipts',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.put 'https://www.concursolutions.com/api/v3.0/invoice/purchaseorderreceipts',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.put('https://www.concursolutions.com/api/v3.0/invoice/purchaseorderreceipts', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','https://www.concursolutions.com/api/v3.0/invoice/purchaseorderreceipts', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/invoice/purchaseorderreceipts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://www.concursolutions.com/api/v3.0/invoice/purchaseorderreceipts", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /invoice/purchaseorderreceipts
Updates purchase order receipts that are already in the system.
Updates purchase order receipts that are already in the system and returns status of the update.
Body parameter
{
"Custom1": "string",
"Custom10": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Deleted": "string",
"DeliverySlipNumber": "string",
"GoodsReceiptNumber": "string",
"ID": "string",
"LineItemExternalID": "string",
"PurchaseOrderNumber": "string",
"ReceivedDate": "string",
"ReceivedQuantity": "string",
"UnitOfMeasureCode": "string",
"URI": "string",
"Version": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<PurchaseOrderReceipt>
<Custom1>string</Custom1>
<Custom10>string</Custom10>
<Custom2>string</Custom2>
<Custom3>string</Custom3>
<Custom4>string</Custom4>
<Custom5>string</Custom5>
<Custom6>string</Custom6>
<Custom7>string</Custom7>
<Custom8>string</Custom8>
<Custom9>string</Custom9>
<Deleted>string</Deleted>
<DeliverySlipNumber>string</DeliverySlipNumber>
<GoodsReceiptNumber>string</GoodsReceiptNumber>
<ID>string</ID>
<LineItemExternalID>string</LineItemExternalID>
<PurchaseOrderNumber>string</PurchaseOrderNumber>
<ReceivedDate>string</ReceivedDate>
<ReceivedQuantity>string</ReceivedQuantity>
<UnitOfMeasureCode>string</UnitOfMeasureCode>
<URI>string</URI>
<Version>string</Version>
</PurchaseOrderReceipt>
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | PurchaseOrderReceipt | true | Purchase order receipt information. |
Example responses
200 Response
{
"ErrorCode": "string",
"ErrorMessage": "string",
"FieldCode": "string",
"LineItemExternalID": "string",
"Message": "string",
"PurchaseOrderNumber": "string",
"Status": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<PurchaseOrderReceiptResult>
<ErrorCode>string</ErrorCode>
<ErrorMessage>string</ErrorMessage>
<FieldCode>string</FieldCode>
<LineItemExternalID>string</LineItemExternalID>
<Message>string</Message>
<PurchaseOrderNumber>string</PurchaseOrderNumber>
<Status>string</Status>
</PurchaseOrderReceiptResult>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | PurchaseOrderReceiptResult |
post__invoice_purchaseorderreceipts
Code samples
# You can also use wget
curl -X POST https://www.concursolutions.com/api/v3.0/invoice/purchaseorderreceipts \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
POST https://www.concursolutions.com/api/v3.0/invoice/purchaseorderreceipts HTTP/1.1
Host: www.concursolutions.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"Custom1": "string",
"Custom10": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Deleted": "string",
"DeliverySlipNumber": "string",
"GoodsReceiptNumber": "string",
"ID": "string",
"LineItemExternalID": "string",
"PurchaseOrderNumber": "string",
"ReceivedDate": "string",
"ReceivedQuantity": "string",
"UnitOfMeasureCode": "string",
"URI": "string",
"Version": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://www.concursolutions.com/api/v3.0/invoice/purchaseorderreceipts',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://www.concursolutions.com/api/v3.0/invoice/purchaseorderreceipts',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://www.concursolutions.com/api/v3.0/invoice/purchaseorderreceipts', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://www.concursolutions.com/api/v3.0/invoice/purchaseorderreceipts', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/invoice/purchaseorderreceipts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://www.concursolutions.com/api/v3.0/invoice/purchaseorderreceipts", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /invoice/purchaseorderreceipts
Create purchase order receiving information for a purchase order line item.
Creates purchase order receipts and associate if to purchase order line item and returns status of updation.
Body parameter
{
"Custom1": "string",
"Custom10": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Deleted": "string",
"DeliverySlipNumber": "string",
"GoodsReceiptNumber": "string",
"ID": "string",
"LineItemExternalID": "string",
"PurchaseOrderNumber": "string",
"ReceivedDate": "string",
"ReceivedQuantity": "string",
"UnitOfMeasureCode": "string",
"URI": "string",
"Version": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<PurchaseOrderReceipt>
<Custom1>string</Custom1>
<Custom10>string</Custom10>
<Custom2>string</Custom2>
<Custom3>string</Custom3>
<Custom4>string</Custom4>
<Custom5>string</Custom5>
<Custom6>string</Custom6>
<Custom7>string</Custom7>
<Custom8>string</Custom8>
<Custom9>string</Custom9>
<Deleted>string</Deleted>
<DeliverySlipNumber>string</DeliverySlipNumber>
<GoodsReceiptNumber>string</GoodsReceiptNumber>
<ID>string</ID>
<LineItemExternalID>string</LineItemExternalID>
<PurchaseOrderNumber>string</PurchaseOrderNumber>
<ReceivedDate>string</ReceivedDate>
<ReceivedQuantity>string</ReceivedQuantity>
<UnitOfMeasureCode>string</UnitOfMeasureCode>
<URI>string</URI>
<Version>string</Version>
</PurchaseOrderReceipt>
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | PurchaseOrderReceipt | true | Purchase order receipt information that needs to be created. |
Example responses
200 Response
{
"ErrorCode": "string",
"ErrorMessage": "string",
"FieldCode": "string",
"LineItemExternalID": "string",
"Message": "string",
"PurchaseOrderNumber": "string",
"Status": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<PurchaseOrderReceiptResult>
<ErrorCode>string</ErrorCode>
<ErrorMessage>string</ErrorMessage>
<FieldCode>string</FieldCode>
<LineItemExternalID>string</LineItemExternalID>
<Message>string</Message>
<PurchaseOrderNumber>string</PurchaseOrderNumber>
<Status>string</Status>
</PurchaseOrderReceiptResult>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | PurchaseOrderReceiptResult |
get__invoice_purchaseorderreceipts
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/invoice/purchaseorderreceipts?goodsReceiptNumber=string&purchaseOrderNumber=string \
-H 'Accept: application/json'
GET https://www.concursolutions.com/api/v3.0/invoice/purchaseorderreceipts?goodsReceiptNumber=string&purchaseOrderNumber=string HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://www.concursolutions.com/api/v3.0/invoice/purchaseorderreceipts?goodsReceiptNumber=string&purchaseOrderNumber=string',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/invoice/purchaseorderreceipts',
params: {
'goodsReceiptNumber' => 'string',
'purchaseOrderNumber' => 'string'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/invoice/purchaseorderreceipts', params={
'goodsReceiptNumber': 'string', 'purchaseOrderNumber': 'string'
}, headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/invoice/purchaseorderreceipts', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/invoice/purchaseorderreceipts?goodsReceiptNumber=string&purchaseOrderNumber=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/invoice/purchaseorderreceipts", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /invoice/purchaseorderreceipts
Gets existing purchase order receipts information.
Gets existing purchase order receipts using below parameters.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| goodsReceiptNumber | query | string | true | Goods receipt number for a purchase order line item receipt. This parameter can be used alone or in combination with the other two parameters. |
| purchaseOrderNumber | query | string | true | The purchase order number. This parameter can be used alone or in combination with the other two parameters. |
| lineItemExternalID | query | string | false | A value that uniquely identifies the line item within the purchase order. This parameter cannot be used alone. It must be used in combination with one or more of the other available parameters. |
Example responses
200 Response
{
"Items": {
"Custom1": "string",
"Custom10": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Deleted": "string",
"DeliverySlipNumber": "string",
"GoodsReceiptNumber": "string",
"ID": "string",
"LineItemExternalID": "string",
"PurchaseOrderNumber": "string",
"ReceivedDate": "string",
"ReceivedQuantity": "string",
"UnitOfMeasureCode": "string",
"URI": "string",
"Version": "string"
},
"NextPage": "string",
"TotalCount": 0,
"Info": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ReceiptsCollection>
<Items>
<Custom1>string</Custom1>
<Custom10>string</Custom10>
<Custom2>string</Custom2>
<Custom3>string</Custom3>
<Custom4>string</Custom4>
<Custom5>string</Custom5>
<Custom6>string</Custom6>
<Custom7>string</Custom7>
<Custom8>string</Custom8>
<Custom9>string</Custom9>
<Deleted>string</Deleted>
<DeliverySlipNumber>string</DeliverySlipNumber>
<GoodsReceiptNumber>string</GoodsReceiptNumber>
<ID>string</ID>
<LineItemExternalID>string</LineItemExternalID>
<PurchaseOrderNumber>string</PurchaseOrderNumber>
<ReceivedDate>string</ReceivedDate>
<ReceivedQuantity>string</ReceivedQuantity>
<UnitOfMeasureCode>string</UnitOfMeasureCode>
<URI>string</URI>
<Version>string</Version>
</Items>
<NextPage>string</NextPage>
<TotalCount>0</TotalCount>
<Info>string</Info>
</ReceiptsCollection>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ReceiptsCollection |
delete__invoice_purchaseorderreceipts
Code samples
# You can also use wget
curl -X DELETE https://www.concursolutions.com/api/v3.0/invoice/purchaseorderreceipts?goodsReceiptNumber=string&purchaseOrderNumber=string \
-H 'Accept: application/json'
DELETE https://www.concursolutions.com/api/v3.0/invoice/purchaseorderreceipts?goodsReceiptNumber=string&purchaseOrderNumber=string HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://www.concursolutions.com/api/v3.0/invoice/purchaseorderreceipts?goodsReceiptNumber=string&purchaseOrderNumber=string',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.delete 'https://www.concursolutions.com/api/v3.0/invoice/purchaseorderreceipts',
params: {
'goodsReceiptNumber' => 'string',
'purchaseOrderNumber' => 'string'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.delete('https://www.concursolutions.com/api/v3.0/invoice/purchaseorderreceipts', params={
'goodsReceiptNumber': 'string', 'purchaseOrderNumber': 'string'
}, headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','https://www.concursolutions.com/api/v3.0/invoice/purchaseorderreceipts', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/invoice/purchaseorderreceipts?goodsReceiptNumber=string&purchaseOrderNumber=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://www.concursolutions.com/api/v3.0/invoice/purchaseorderreceipts", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /invoice/purchaseorderreceipts
Deletes a purchase order line item receipt.
Deletes a existing purchase order line item receipt using the available parameters below. The delete will only be executed if a unique record is found and not associated to a payment request.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| goodsReceiptNumber | query | string | true | Goods receipt number for a purchase order line item receipt. This parameter can be used alone or in combination with the other two parameters. |
| purchaseOrderNumber | query | string | true | The purchase order number. This parameter can be used alone or in combination with the other two parameters. |
| lineItemExternalID | query | string | false | A value that uniquely identifies the line item within the purchase order. This parameter cannot be used alone. It must be used in combination with one or more of the other available parameters. |
Example responses
200 Response
{}
<?xml version="1.0" encoding="UTF-8" ?>
<Void/>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Void |
Schemas
PurchaseOrderReceipt
{
"Custom1": "string",
"Custom10": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Deleted": "string",
"DeliverySlipNumber": "string",
"GoodsReceiptNumber": "string",
"ID": "string",
"LineItemExternalID": "string",
"PurchaseOrderNumber": "string",
"ReceivedDate": "string",
"ReceivedQuantity": "string",
"UnitOfMeasureCode": "string",
"URI": "string",
"Version": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Custom1 | string | false | none | Custom 1 value for purchase order line item receipt. |
| Custom10 | string | false | none | Custom 10 value for purchase order line item receipt. |
| Custom2 | string | false | none | Custom 2 value for purchase order line item receipt. |
| Custom3 | string | false | none | Custom 3 value for purchase order line item receipt. |
| Custom4 | string | false | none | Custom 4 value for purchase order line item receipt. |
| Custom5 | string | false | none | Custom 5 value for purchase order line item receipt. |
| Custom6 | string | false | none | Custom 6 value for purchase order line item receipt. |
| Custom7 | string | false | none | Custom 7 value for purchase order line item receipt. |
| Custom8 | string | false | none | Custom 8 value for purchase order line item receipt. |
| Custom9 | string | false | none | Custom 9 value for purchase order line item receipt. |
| Deleted | string | false | none | Delete status of purchase order line item receipt. |
| DeliverySlipNumber | string | false | none | Delivery slip number for a purchase order line item receipt. |
| GoodsReceiptNumber | string | false | none | Goods receipt number for a purchase order line item receipt. This field is Required for V2 Version when using Concur Receiving. |
| ID | string | false | none | The unique identifier of the resource. |
| LineItemExternalID | string | true | none | A customer-supplied value that uniquely identifies the line item within the purchase order. |
| PurchaseOrderNumber | string | true | none | The purchase order number. |
| ReceivedDate | string | false | none | The date the line item was received. Format: YYYY-MM-DD |
| ReceivedQuantity | string | false | none | The number of items that were received. |
| UnitOfMeasureCode | string | false | none | Unit of measure code for a purchase order line item receipt. |
| URI | string | false | none | The URI to the resource. |
| Version | string | false | none | The version of purchase order line item receipt. Use Version 2.0 here unless doing receipt confirmation only. |
PurchaseOrderReceiptResult
{
"ErrorCode": "string",
"ErrorMessage": "string",
"FieldCode": "string",
"LineItemExternalID": "string",
"Message": "string",
"PurchaseOrderNumber": "string",
"Status": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ErrorCode | string | false | none | A code that indicates why the purchase order receipt was not processed successfully. |
| ErrorMessage | string | false | none | A description of the error. |
| FieldCode | string | false | none | A code that indicates which field caused an issue. |
| LineItemExternalID | string | false | none | The external ID of a line item that caused an error. |
| Message | string | false | none | Message of request result. |
| PurchaseOrderNumber | string | false | none | The purchase order number. |
| Status | string | false | none | The result of processing the purchase order receipt. Format: SUCCESS or FAILURE |
ReceiptsCollection
{
"Items": {
"Custom1": "string",
"Custom10": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Deleted": "string",
"DeliverySlipNumber": "string",
"GoodsReceiptNumber": "string",
"ID": "string",
"LineItemExternalID": "string",
"PurchaseOrderNumber": "string",
"ReceivedDate": "string",
"ReceivedQuantity": "string",
"UnitOfMeasureCode": "string",
"URI": "string",
"Version": "string"
},
"NextPage": "string",
"TotalCount": 0,
"Info": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Items | PurchaseOrderReceipt | false | none | none |
| NextPage | string | false | none | The URI of the next page of results, if any |
| TotalCount | integer(int32) | false | none | Total number of receipts |
| Info | string | false | none | Any additional information messages |
Void
{}
Properties
None
Purchase Orders v3.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
In Concur Invoice, purchase orders are requests for a vendor to supply goods or services. This API provides methods to create a new purchase order, or view or update an existing purchase order.
Base URLs:
Resources
post__invoice_purchaseorders
Code samples
# You can also use wget
curl -X POST https://www.concursolutions.com/api/v3.0/invoice/purchaseorders \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://www.concursolutions.com/api/v3.0/invoice/purchaseorders HTTP/1.1
Host: www.concursolutions.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"AmountWithoutVat": "string",
"BillToAddress": {
"Address1": "string",
"Address2": "string",
"Address3": "string",
"City": "string",
"CountryCode": "string",
"ExternalID": "string",
"Name": "string",
"PostalCode": "string",
"State": "string",
"StateProvince": "string"
},
"CurrencyCode": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom21": "string",
"Custom22": "string",
"Custom23": "string",
"Custom24": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Description": "string",
"DiscountPercentage": "string",
"DiscountTerms": "string",
"ID": "string",
"IsTest": true,
"IsChangeOrder": true,
"LedgerCode": "string",
"LineItem": [
{
"AccountCode": "string",
"Allocation": [
{
"Amount": "string",
"Custom1": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"GrossAmount": "string",
"Percentage": "string"
}
],
"AmountWithoutVat": "string",
"CreateDate": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Description": "string",
"ExpenseType": "string",
"ExternalID": "string",
"IsReceiptRequired": "string",
"LineNumber": "string",
"PurchaseOrderReceiptType": "string",
"Quantity": "string",
"RequestedBy": "string",
"RequestedDeliveryDate": "string",
"SupplierPartID": "string",
"Tax": "string",
"UnitOfMeasureCode": "string",
"UnitPrice": "string",
"VatAmount": "string",
"VatRate": "string"
}
],
"Name": "string",
"NeededByDate": "string",
"OrderDate": "string",
"PaymentTerms": "string",
"PolicyExternalID": "string",
"PoVendorTaxId": "string",
"ProvincialTaxId": "string",
"PurchaseOrderNumber": "string",
"PurchaseRequestNumber": "string",
"ReceiptType": "string",
"RequestedBy": "string",
"RequestedDeliveryDate": "string",
"Shipping": "string",
"ShippingDescription": "string",
"ShippingMethodKey": "string",
"ShippingTermsKey": "string",
"ShipToAddress": {
"Address1": "string",
"Address2": "string",
"Address3": "string",
"City": "string",
"CountryCode": "string",
"ExternalID": "string",
"Name": "string",
"PostalCode": "string",
"State": "string",
"StateProvince": "string"
},
"Status": "string",
"Tax": "string",
"URI": "string",
"VatAmountOne": "string",
"VatAmountTwo": "string",
"VatRateOne": "string",
"VatRateTwo": "string",
"VendorAccountNumber": "string",
"VendorAddressCode": "string",
"VendorCode": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/invoice/purchaseorders',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://www.concursolutions.com/api/v3.0/invoice/purchaseorders',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://www.concursolutions.com/api/v3.0/invoice/purchaseorders', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://www.concursolutions.com/api/v3.0/invoice/purchaseorders', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/invoice/purchaseorders");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://www.concursolutions.com/api/v3.0/invoice/purchaseorders", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /invoice/purchaseorders
Create a purchase order
Creates a purchase order and returns the status of the creation request.
Body parameter
{
"AmountWithoutVat": "string",
"BillToAddress": {
"Address1": "string",
"Address2": "string",
"Address3": "string",
"City": "string",
"CountryCode": "string",
"ExternalID": "string",
"Name": "string",
"PostalCode": "string",
"State": "string",
"StateProvince": "string"
},
"CurrencyCode": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom21": "string",
"Custom22": "string",
"Custom23": "string",
"Custom24": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Description": "string",
"DiscountPercentage": "string",
"DiscountTerms": "string",
"ID": "string",
"IsTest": true,
"IsChangeOrder": true,
"LedgerCode": "string",
"LineItem": [
{
"AccountCode": "string",
"Allocation": [
{
"Amount": "string",
"Custom1": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"GrossAmount": "string",
"Percentage": "string"
}
],
"AmountWithoutVat": "string",
"CreateDate": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Description": "string",
"ExpenseType": "string",
"ExternalID": "string",
"IsReceiptRequired": "string",
"LineNumber": "string",
"PurchaseOrderReceiptType": "string",
"Quantity": "string",
"RequestedBy": "string",
"RequestedDeliveryDate": "string",
"SupplierPartID": "string",
"Tax": "string",
"UnitOfMeasureCode": "string",
"UnitPrice": "string",
"VatAmount": "string",
"VatRate": "string"
}
],
"Name": "string",
"NeededByDate": "string",
"OrderDate": "string",
"PaymentTerms": "string",
"PolicyExternalID": "string",
"PoVendorTaxId": "string",
"ProvincialTaxId": "string",
"PurchaseOrderNumber": "string",
"PurchaseRequestNumber": "string",
"ReceiptType": "string",
"RequestedBy": "string",
"RequestedDeliveryDate": "string",
"Shipping": "string",
"ShippingDescription": "string",
"ShippingMethodKey": "string",
"ShippingTermsKey": "string",
"ShipToAddress": {
"Address1": "string",
"Address2": "string",
"Address3": "string",
"City": "string",
"CountryCode": "string",
"ExternalID": "string",
"Name": "string",
"PostalCode": "string",
"State": "string",
"StateProvince": "string"
},
"Status": "string",
"Tax": "string",
"URI": "string",
"VatAmountOne": "string",
"VatAmountTwo": "string",
"VatRateOne": "string",
"VatRateTwo": "string",
"VendorAccountNumber": "string",
"VendorAddressCode": "string",
"VendorCode": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<PurchaseOrder>
<AmountWithoutVat>string</AmountWithoutVat>
<BillToAddress>
<Address1>string</Address1>
<Address2>string</Address2>
<Address3>string</Address3>
<City>string</City>
<CountryCode>string</CountryCode>
<ExternalID>string</ExternalID>
<Name>string</Name>
<PostalCode>string</PostalCode>
<State>string</State>
<StateProvince>string</StateProvince>
</BillToAddress>
<CurrencyCode>string</CurrencyCode>
<Custom1>string</Custom1>
<Custom10>string</Custom10>
<Custom11>string</Custom11>
<Custom12>string</Custom12>
<Custom13>string</Custom13>
<Custom14>string</Custom14>
<Custom15>string</Custom15>
<Custom16>string</Custom16>
<Custom17>string</Custom17>
<Custom18>string</Custom18>
<Custom19>string</Custom19>
<Custom2>string</Custom2>
<Custom20>string</Custom20>
<Custom21>string</Custom21>
<Custom22>string</Custom22>
<Custom23>string</Custom23>
<Custom24>string</Custom24>
<Custom3>string</Custom3>
<Custom4>string</Custom4>
<Custom5>string</Custom5>
<Custom6>string</Custom6>
<Custom7>string</Custom7>
<Custom8>string</Custom8>
<Custom9>string</Custom9>
<Description>string</Description>
<DiscountPercentage>string</DiscountPercentage>
<DiscountTerms>string</DiscountTerms>
<ID>string</ID>
<IsTest>true</IsTest>
<IsChangeOrder>true</IsChangeOrder>
<LedgerCode>string</LedgerCode>
<LineItem>
<AccountCode>string</AccountCode>
<Allocation>
<Amount>string</Amount>
<Custom1>string</Custom1>
<Custom2>string</Custom2>
<Custom3>string</Custom3>
<Custom4>string</Custom4>
<Custom5>string</Custom5>
<Custom6>string</Custom6>
<Custom7>string</Custom7>
<Custom8>string</Custom8>
<Custom9>string</Custom9>
<Custom10>string</Custom10>
<Custom11>string</Custom11>
<Custom12>string</Custom12>
<Custom13>string</Custom13>
<Custom14>string</Custom14>
<Custom15>string</Custom15>
<Custom16>string</Custom16>
<Custom17>string</Custom17>
<Custom18>string</Custom18>
<Custom19>string</Custom19>
<Custom20>string</Custom20>
<GrossAmount>string</GrossAmount>
<Percentage>string</Percentage>
</Allocation>
<AmountWithoutVat>string</AmountWithoutVat>
<CreateDate>string</CreateDate>
<Custom1>string</Custom1>
<Custom10>string</Custom10>
<Custom11>string</Custom11>
<Custom12>string</Custom12>
<Custom13>string</Custom13>
<Custom14>string</Custom14>
<Custom15>string</Custom15>
<Custom16>string</Custom16>
<Custom17>string</Custom17>
<Custom18>string</Custom18>
<Custom19>string</Custom19>
<Custom2>string</Custom2>
<Custom20>string</Custom20>
<Custom3>string</Custom3>
<Custom4>string</Custom4>
<Custom5>string</Custom5>
<Custom6>string</Custom6>
<Custom7>string</Custom7>
<Custom8>string</Custom8>
<Custom9>string</Custom9>
<Description>string</Description>
<ExpenseType>string</ExpenseType>
<ExternalID>string</ExternalID>
<IsReceiptRequired>string</IsReceiptRequired>
<LineNumber>string</LineNumber>
<PurchaseOrderReceiptType>string</PurchaseOrderReceiptType>
<Quantity>string</Quantity>
<RequestedBy>string</RequestedBy>
<RequestedDeliveryDate>string</RequestedDeliveryDate>
<SupplierPartID>string</SupplierPartID>
<Tax>string</Tax>
<UnitOfMeasureCode>string</UnitOfMeasureCode>
<UnitPrice>string</UnitPrice>
<VatAmount>string</VatAmount>
<VatRate>string</VatRate>
</LineItem>
<Name>string</Name>
<NeededByDate>string</NeededByDate>
<OrderDate>string</OrderDate>
<PaymentTerms>string</PaymentTerms>
<PolicyExternalID>string</PolicyExternalID>
<PoVendorTaxId>string</PoVendorTaxId>
<ProvincialTaxId>string</ProvincialTaxId>
<PurchaseOrderNumber>string</PurchaseOrderNumber>
<PurchaseRequestNumber>string</PurchaseRequestNumber>
<ReceiptType>string</ReceiptType>
<RequestedBy>string</RequestedBy>
<RequestedDeliveryDate>string</RequestedDeliveryDate>
<Shipping>string</Shipping>
<ShippingDescription>string</ShippingDescription>
<ShippingMethodKey>string</ShippingMethodKey>
<ShippingTermsKey>string</ShippingTermsKey>
<ShipToAddress>
<Address1>string</Address1>
<Address2>string</Address2>
<Address3>string</Address3>
<City>string</City>
<CountryCode>string</CountryCode>
<ExternalID>string</ExternalID>
<Name>string</Name>
<PostalCode>string</PostalCode>
<State>string</State>
<StateProvince>string</StateProvince>
</ShipToAddress>
<Status>string</Status>
<Tax>string</Tax>
<URI>string</URI>
<VatAmountOne>string</VatAmountOne>
<VatAmountTwo>string</VatAmountTwo>
<VatRateOne>string</VatRateOne>
<VatRateTwo>string</VatRateTwo>
<VendorAccountNumber>string</VendorAccountNumber>
<VendorAddressCode>string</VendorAddressCode>
<VendorCode>string</VendorCode>
</PurchaseOrder>
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | PurchaseOrder | true | The details of the purchase order. |
Example responses
200 Response
{
"ErrorCode": "string",
"ErrorMessage": "string",
"FieldCode": "string",
"LineItemExternalID": "string",
"Message": "string",
"PurchaseOrderNumber": "string",
"Status": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<PurchaseOrderResult>
<ErrorCode>string</ErrorCode>
<ErrorMessage>string</ErrorMessage>
<FieldCode>string</FieldCode>
<LineItemExternalID>string</LineItemExternalID>
<Message>string</Message>
<PurchaseOrderNumber>string</PurchaseOrderNumber>
<Status>string</Status>
</PurchaseOrderResult>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | PurchaseOrderResult |
| 400 | Bad Request | Bad Request | Void |
put__invoice_purchaseorders
Code samples
# You can also use wget
curl -X PUT https://www.concursolutions.com/api/v3.0/invoice/purchaseorders \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
PUT https://www.concursolutions.com/api/v3.0/invoice/purchaseorders HTTP/1.1
Host: www.concursolutions.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"AmountWithoutVat": "string",
"BillToAddress": {
"Address1": "string",
"Address2": "string",
"Address3": "string",
"City": "string",
"CountryCode": "string",
"ExternalID": "string",
"Name": "string",
"PostalCode": "string",
"State": "string",
"StateProvince": "string"
},
"CurrencyCode": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom21": "string",
"Custom22": "string",
"Custom23": "string",
"Custom24": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Description": "string",
"DiscountPercentage": "string",
"DiscountTerms": "string",
"ID": "string",
"IsTest": true,
"IsChangeOrder": true,
"LedgerCode": "string",
"LineItem": [
{
"AccountCode": "string",
"Allocation": [
{
"Amount": "string",
"Custom1": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"GrossAmount": "string",
"Percentage": "string"
}
],
"AmountWithoutVat": "string",
"CreateDate": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Description": "string",
"ExpenseType": "string",
"ExternalID": "string",
"IsReceiptRequired": "string",
"LineNumber": "string",
"PurchaseOrderReceiptType": "string",
"Quantity": "string",
"RequestedBy": "string",
"RequestedDeliveryDate": "string",
"SupplierPartID": "string",
"Tax": "string",
"UnitOfMeasureCode": "string",
"UnitPrice": "string",
"VatAmount": "string",
"VatRate": "string"
}
],
"Name": "string",
"NeededByDate": "string",
"OrderDate": "string",
"PaymentTerms": "string",
"PolicyExternalID": "string",
"PoVendorTaxId": "string",
"ProvincialTaxId": "string",
"PurchaseOrderNumber": "string",
"PurchaseRequestNumber": "string",
"ReceiptType": "string",
"RequestedBy": "string",
"RequestedDeliveryDate": "string",
"Shipping": "string",
"ShippingDescription": "string",
"ShippingMethodKey": "string",
"ShippingTermsKey": "string",
"ShipToAddress": {
"Address1": "string",
"Address2": "string",
"Address3": "string",
"City": "string",
"CountryCode": "string",
"ExternalID": "string",
"Name": "string",
"PostalCode": "string",
"State": "string",
"StateProvince": "string"
},
"Status": "string",
"Tax": "string",
"URI": "string",
"VatAmountOne": "string",
"VatAmountTwo": "string",
"VatRateOne": "string",
"VatRateTwo": "string",
"VendorAccountNumber": "string",
"VendorAddressCode": "string",
"VendorCode": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/invoice/purchaseorders',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put 'https://www.concursolutions.com/api/v3.0/invoice/purchaseorders',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('https://www.concursolutions.com/api/v3.0/invoice/purchaseorders', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','https://www.concursolutions.com/api/v3.0/invoice/purchaseorders', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/invoice/purchaseorders");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://www.concursolutions.com/api/v3.0/invoice/purchaseorders", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /invoice/purchaseorders
Update a purchase order.
Updates the specified purchase order and returns the status of the update request.
Body parameter
{
"AmountWithoutVat": "string",
"BillToAddress": {
"Address1": "string",
"Address2": "string",
"Address3": "string",
"City": "string",
"CountryCode": "string",
"ExternalID": "string",
"Name": "string",
"PostalCode": "string",
"State": "string",
"StateProvince": "string"
},
"CurrencyCode": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom21": "string",
"Custom22": "string",
"Custom23": "string",
"Custom24": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Description": "string",
"DiscountPercentage": "string",
"DiscountTerms": "string",
"ID": "string",
"IsTest": true,
"IsChangeOrder": true,
"LedgerCode": "string",
"LineItem": [
{
"AccountCode": "string",
"Allocation": [
{
"Amount": "string",
"Custom1": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"GrossAmount": "string",
"Percentage": "string"
}
],
"AmountWithoutVat": "string",
"CreateDate": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Description": "string",
"ExpenseType": "string",
"ExternalID": "string",
"IsReceiptRequired": "string",
"LineNumber": "string",
"PurchaseOrderReceiptType": "string",
"Quantity": "string",
"RequestedBy": "string",
"RequestedDeliveryDate": "string",
"SupplierPartID": "string",
"Tax": "string",
"UnitOfMeasureCode": "string",
"UnitPrice": "string",
"VatAmount": "string",
"VatRate": "string"
}
],
"Name": "string",
"NeededByDate": "string",
"OrderDate": "string",
"PaymentTerms": "string",
"PolicyExternalID": "string",
"PoVendorTaxId": "string",
"ProvincialTaxId": "string",
"PurchaseOrderNumber": "string",
"PurchaseRequestNumber": "string",
"ReceiptType": "string",
"RequestedBy": "string",
"RequestedDeliveryDate": "string",
"Shipping": "string",
"ShippingDescription": "string",
"ShippingMethodKey": "string",
"ShippingTermsKey": "string",
"ShipToAddress": {
"Address1": "string",
"Address2": "string",
"Address3": "string",
"City": "string",
"CountryCode": "string",
"ExternalID": "string",
"Name": "string",
"PostalCode": "string",
"State": "string",
"StateProvince": "string"
},
"Status": "string",
"Tax": "string",
"URI": "string",
"VatAmountOne": "string",
"VatAmountTwo": "string",
"VatRateOne": "string",
"VatRateTwo": "string",
"VendorAccountNumber": "string",
"VendorAddressCode": "string",
"VendorCode": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<PurchaseOrder>
<AmountWithoutVat>string</AmountWithoutVat>
<BillToAddress>
<Address1>string</Address1>
<Address2>string</Address2>
<Address3>string</Address3>
<City>string</City>
<CountryCode>string</CountryCode>
<ExternalID>string</ExternalID>
<Name>string</Name>
<PostalCode>string</PostalCode>
<State>string</State>
<StateProvince>string</StateProvince>
</BillToAddress>
<CurrencyCode>string</CurrencyCode>
<Custom1>string</Custom1>
<Custom10>string</Custom10>
<Custom11>string</Custom11>
<Custom12>string</Custom12>
<Custom13>string</Custom13>
<Custom14>string</Custom14>
<Custom15>string</Custom15>
<Custom16>string</Custom16>
<Custom17>string</Custom17>
<Custom18>string</Custom18>
<Custom19>string</Custom19>
<Custom2>string</Custom2>
<Custom20>string</Custom20>
<Custom21>string</Custom21>
<Custom22>string</Custom22>
<Custom23>string</Custom23>
<Custom24>string</Custom24>
<Custom3>string</Custom3>
<Custom4>string</Custom4>
<Custom5>string</Custom5>
<Custom6>string</Custom6>
<Custom7>string</Custom7>
<Custom8>string</Custom8>
<Custom9>string</Custom9>
<Description>string</Description>
<DiscountPercentage>string</DiscountPercentage>
<DiscountTerms>string</DiscountTerms>
<ID>string</ID>
<IsTest>true</IsTest>
<IsChangeOrder>true</IsChangeOrder>
<LedgerCode>string</LedgerCode>
<LineItem>
<AccountCode>string</AccountCode>
<Allocation>
<Amount>string</Amount>
<Custom1>string</Custom1>
<Custom2>string</Custom2>
<Custom3>string</Custom3>
<Custom4>string</Custom4>
<Custom5>string</Custom5>
<Custom6>string</Custom6>
<Custom7>string</Custom7>
<Custom8>string</Custom8>
<Custom9>string</Custom9>
<Custom10>string</Custom10>
<Custom11>string</Custom11>
<Custom12>string</Custom12>
<Custom13>string</Custom13>
<Custom14>string</Custom14>
<Custom15>string</Custom15>
<Custom16>string</Custom16>
<Custom17>string</Custom17>
<Custom18>string</Custom18>
<Custom19>string</Custom19>
<Custom20>string</Custom20>
<GrossAmount>string</GrossAmount>
<Percentage>string</Percentage>
</Allocation>
<AmountWithoutVat>string</AmountWithoutVat>
<CreateDate>string</CreateDate>
<Custom1>string</Custom1>
<Custom10>string</Custom10>
<Custom11>string</Custom11>
<Custom12>string</Custom12>
<Custom13>string</Custom13>
<Custom14>string</Custom14>
<Custom15>string</Custom15>
<Custom16>string</Custom16>
<Custom17>string</Custom17>
<Custom18>string</Custom18>
<Custom19>string</Custom19>
<Custom2>string</Custom2>
<Custom20>string</Custom20>
<Custom3>string</Custom3>
<Custom4>string</Custom4>
<Custom5>string</Custom5>
<Custom6>string</Custom6>
<Custom7>string</Custom7>
<Custom8>string</Custom8>
<Custom9>string</Custom9>
<Description>string</Description>
<ExpenseType>string</ExpenseType>
<ExternalID>string</ExternalID>
<IsReceiptRequired>string</IsReceiptRequired>
<LineNumber>string</LineNumber>
<PurchaseOrderReceiptType>string</PurchaseOrderReceiptType>
<Quantity>string</Quantity>
<RequestedBy>string</RequestedBy>
<RequestedDeliveryDate>string</RequestedDeliveryDate>
<SupplierPartID>string</SupplierPartID>
<Tax>string</Tax>
<UnitOfMeasureCode>string</UnitOfMeasureCode>
<UnitPrice>string</UnitPrice>
<VatAmount>string</VatAmount>
<VatRate>string</VatRate>
</LineItem>
<Name>string</Name>
<NeededByDate>string</NeededByDate>
<OrderDate>string</OrderDate>
<PaymentTerms>string</PaymentTerms>
<PolicyExternalID>string</PolicyExternalID>
<PoVendorTaxId>string</PoVendorTaxId>
<ProvincialTaxId>string</ProvincialTaxId>
<PurchaseOrderNumber>string</PurchaseOrderNumber>
<PurchaseRequestNumber>string</PurchaseRequestNumber>
<ReceiptType>string</ReceiptType>
<RequestedBy>string</RequestedBy>
<RequestedDeliveryDate>string</RequestedDeliveryDate>
<Shipping>string</Shipping>
<ShippingDescription>string</ShippingDescription>
<ShippingMethodKey>string</ShippingMethodKey>
<ShippingTermsKey>string</ShippingTermsKey>
<ShipToAddress>
<Address1>string</Address1>
<Address2>string</Address2>
<Address3>string</Address3>
<City>string</City>
<CountryCode>string</CountryCode>
<ExternalID>string</ExternalID>
<Name>string</Name>
<PostalCode>string</PostalCode>
<State>string</State>
<StateProvince>string</StateProvince>
</ShipToAddress>
<Status>string</Status>
<Tax>string</Tax>
<URI>string</URI>
<VatAmountOne>string</VatAmountOne>
<VatAmountTwo>string</VatAmountTwo>
<VatRateOne>string</VatRateOne>
<VatRateTwo>string</VatRateTwo>
<VendorAccountNumber>string</VendorAccountNumber>
<VendorAddressCode>string</VendorAddressCode>
<VendorCode>string</VendorCode>
</PurchaseOrder>
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | PurchaseOrder | true | The details of the purchase order. |
Example responses
200 Response
{
"ErrorCode": "string",
"ErrorMessage": "string",
"FieldCode": "string",
"LineItemExternalID": "string",
"Message": "string",
"PurchaseOrderNumber": "string",
"Status": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<PurchaseOrderResult>
<ErrorCode>string</ErrorCode>
<ErrorMessage>string</ErrorMessage>
<FieldCode>string</FieldCode>
<LineItemExternalID>string</LineItemExternalID>
<Message>string</Message>
<PurchaseOrderNumber>string</PurchaseOrderNumber>
<Status>string</Status>
</PurchaseOrderResult>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | PurchaseOrderResult |
| 400 | Bad Request | Bad Request | Void |
get_invoice_purchaseorders{id}
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/invoice/purchaseorders/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://www.concursolutions.com/api/v3.0/invoice/purchaseorders/{id} HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/invoice/purchaseorders/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/invoice/purchaseorders/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/invoice/purchaseorders/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/invoice/purchaseorders/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/invoice/purchaseorders/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/invoice/purchaseorders/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /invoice/purchaseorders/{id}
Get a purchase order.
Retrieves information about the specified purchase order.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The identifier for the purchase order. |
Example responses
200 Response
{
"AmountWithoutVat": "string",
"BillToAddress": {
"Address1": "string",
"Address2": "string",
"Address3": "string",
"City": "string",
"CountryCode": "string",
"ExternalID": "string",
"Name": "string",
"PostalCode": "string",
"State": "string",
"StateProvince": "string"
},
"CurrencyCode": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom21": "string",
"Custom22": "string",
"Custom23": "string",
"Custom24": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Description": "string",
"DiscountPercentage": "string",
"DiscountTerms": "string",
"ID": "string",
"IsTest": true,
"IsChangeOrder": true,
"LedgerCode": "string",
"LineItem": [
{
"AccountCode": "string",
"Allocation": [
{
"Amount": "string",
"Custom1": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"GrossAmount": "string",
"Percentage": "string"
}
],
"AmountWithoutVat": "string",
"CreateDate": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Description": "string",
"ExpenseType": "string",
"ExternalID": "string",
"IsReceiptRequired": "string",
"LineNumber": "string",
"PurchaseOrderReceiptType": "string",
"Quantity": "string",
"RequestedBy": "string",
"RequestedDeliveryDate": "string",
"SupplierPartID": "string",
"Tax": "string",
"UnitOfMeasureCode": "string",
"UnitPrice": "string",
"VatAmount": "string",
"VatRate": "string"
}
],
"Name": "string",
"NeededByDate": "string",
"OrderDate": "string",
"PaymentTerms": "string",
"PolicyExternalID": "string",
"PoVendorTaxId": "string",
"ProvincialTaxId": "string",
"PurchaseOrderNumber": "string",
"PurchaseRequestNumber": "string",
"ReceiptType": "string",
"RequestedBy": "string",
"RequestedDeliveryDate": "string",
"Shipping": "string",
"ShippingDescription": "string",
"ShippingMethodKey": "string",
"ShippingTermsKey": "string",
"ShipToAddress": {
"Address1": "string",
"Address2": "string",
"Address3": "string",
"City": "string",
"CountryCode": "string",
"ExternalID": "string",
"Name": "string",
"PostalCode": "string",
"State": "string",
"StateProvince": "string"
},
"Status": "string",
"Tax": "string",
"URI": "string",
"VatAmountOne": "string",
"VatAmountTwo": "string",
"VatRateOne": "string",
"VatRateTwo": "string",
"VendorAccountNumber": "string",
"VendorAddressCode": "string",
"VendorCode": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<PurchaseOrder>
<AmountWithoutVat>string</AmountWithoutVat>
<BillToAddress>
<Address1>string</Address1>
<Address2>string</Address2>
<Address3>string</Address3>
<City>string</City>
<CountryCode>string</CountryCode>
<ExternalID>string</ExternalID>
<Name>string</Name>
<PostalCode>string</PostalCode>
<State>string</State>
<StateProvince>string</StateProvince>
</BillToAddress>
<CurrencyCode>string</CurrencyCode>
<Custom1>string</Custom1>
<Custom10>string</Custom10>
<Custom11>string</Custom11>
<Custom12>string</Custom12>
<Custom13>string</Custom13>
<Custom14>string</Custom14>
<Custom15>string</Custom15>
<Custom16>string</Custom16>
<Custom17>string</Custom17>
<Custom18>string</Custom18>
<Custom19>string</Custom19>
<Custom2>string</Custom2>
<Custom20>string</Custom20>
<Custom21>string</Custom21>
<Custom22>string</Custom22>
<Custom23>string</Custom23>
<Custom24>string</Custom24>
<Custom3>string</Custom3>
<Custom4>string</Custom4>
<Custom5>string</Custom5>
<Custom6>string</Custom6>
<Custom7>string</Custom7>
<Custom8>string</Custom8>
<Custom9>string</Custom9>
<Description>string</Description>
<DiscountPercentage>string</DiscountPercentage>
<DiscountTerms>string</DiscountTerms>
<ID>string</ID>
<IsTest>true</IsTest>
<IsChangeOrder>true</IsChangeOrder>
<LedgerCode>string</LedgerCode>
<LineItem>
<AccountCode>string</AccountCode>
<Allocation>
<Amount>string</Amount>
<Custom1>string</Custom1>
<Custom2>string</Custom2>
<Custom3>string</Custom3>
<Custom4>string</Custom4>
<Custom5>string</Custom5>
<Custom6>string</Custom6>
<Custom7>string</Custom7>
<Custom8>string</Custom8>
<Custom9>string</Custom9>
<Custom10>string</Custom10>
<Custom11>string</Custom11>
<Custom12>string</Custom12>
<Custom13>string</Custom13>
<Custom14>string</Custom14>
<Custom15>string</Custom15>
<Custom16>string</Custom16>
<Custom17>string</Custom17>
<Custom18>string</Custom18>
<Custom19>string</Custom19>
<Custom20>string</Custom20>
<GrossAmount>string</GrossAmount>
<Percentage>string</Percentage>
</Allocation>
<AmountWithoutVat>string</AmountWithoutVat>
<CreateDate>string</CreateDate>
<Custom1>string</Custom1>
<Custom10>string</Custom10>
<Custom11>string</Custom11>
<Custom12>string</Custom12>
<Custom13>string</Custom13>
<Custom14>string</Custom14>
<Custom15>string</Custom15>
<Custom16>string</Custom16>
<Custom17>string</Custom17>
<Custom18>string</Custom18>
<Custom19>string</Custom19>
<Custom2>string</Custom2>
<Custom20>string</Custom20>
<Custom3>string</Custom3>
<Custom4>string</Custom4>
<Custom5>string</Custom5>
<Custom6>string</Custom6>
<Custom7>string</Custom7>
<Custom8>string</Custom8>
<Custom9>string</Custom9>
<Description>string</Description>
<ExpenseType>string</ExpenseType>
<ExternalID>string</ExternalID>
<IsReceiptRequired>string</IsReceiptRequired>
<LineNumber>string</LineNumber>
<PurchaseOrderReceiptType>string</PurchaseOrderReceiptType>
<Quantity>string</Quantity>
<RequestedBy>string</RequestedBy>
<RequestedDeliveryDate>string</RequestedDeliveryDate>
<SupplierPartID>string</SupplierPartID>
<Tax>string</Tax>
<UnitOfMeasureCode>string</UnitOfMeasureCode>
<UnitPrice>string</UnitPrice>
<VatAmount>string</VatAmount>
<VatRate>string</VatRate>
</LineItem>
<Name>string</Name>
<NeededByDate>string</NeededByDate>
<OrderDate>string</OrderDate>
<PaymentTerms>string</PaymentTerms>
<PolicyExternalID>string</PolicyExternalID>
<PoVendorTaxId>string</PoVendorTaxId>
<ProvincialTaxId>string</ProvincialTaxId>
<PurchaseOrderNumber>string</PurchaseOrderNumber>
<PurchaseRequestNumber>string</PurchaseRequestNumber>
<ReceiptType>string</ReceiptType>
<RequestedBy>string</RequestedBy>
<RequestedDeliveryDate>string</RequestedDeliveryDate>
<Shipping>string</Shipping>
<ShippingDescription>string</ShippingDescription>
<ShippingMethodKey>string</ShippingMethodKey>
<ShippingTermsKey>string</ShippingTermsKey>
<ShipToAddress>
<Address1>string</Address1>
<Address2>string</Address2>
<Address3>string</Address3>
<City>string</City>
<CountryCode>string</CountryCode>
<ExternalID>string</ExternalID>
<Name>string</Name>
<PostalCode>string</PostalCode>
<State>string</State>
<StateProvince>string</StateProvince>
</ShipToAddress>
<Status>string</Status>
<Tax>string</Tax>
<URI>string</URI>
<VatAmountOne>string</VatAmountOne>
<VatAmountTwo>string</VatAmountTwo>
<VatRateOne>string</VatRateOne>
<VatRateTwo>string</VatRateTwo>
<VendorAccountNumber>string</VendorAccountNumber>
<VendorAddressCode>string</VendorAddressCode>
<VendorCode>string</VendorCode>
</PurchaseOrder>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | PurchaseOrder |
Schemas
Allocation
{
"Amount": "string",
"Custom1": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"GrossAmount": "string",
"Percentage": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Amount | string | true | none | Required. The total amount of the allocation. |
| Custom1 | string | false | none | A value that can be applied to a custom field 1 that is part of the allocation form. |
| Custom2 | string | false | none | A value that can be applied to a custom field 10 that is part of the allocation form. |
| Custom3 | string | false | none | A value that can be applied to a custom field 11 that is part of the allocation form. |
| Custom4 | string | false | none | A value that can be applied to a custom field 12 that is part of the allocation form. |
| Custom5 | string | false | none | A value that can be applied to a custom field 13 that is part of the allocation form. |
| Custom6 | string | false | none | A value that can be applied to a custom field 14 that is part of the allocation form. |
| Custom7 | string | false | none | A value that can be applied to a custom field 15 that is part of the allocation form. |
| Custom8 | string | false | none | A value that can be applied to a custom field 16 that is part of the allocation form. |
| Custom9 | string | false | none | A value that can be applied to a custom field 17 that is part of the allocation form. |
| Custom10 | string | false | none | A value that can be applied to a custom field 18 that is part of the allocation form. |
| Custom11 | string | false | none | A value that can be applied to a custom field 19 that is part of the allocation form. |
| Custom12 | string | false | none | A value that can be applied to a custom field 2 that is part of the allocation form. |
| Custom13 | string | false | none | A value that can be applied to a custom field 20 that is part of the allocation form. |
| Custom14 | string | false | none | A value that can be applied to a custom field 3 that is part of the allocation form. |
| Custom15 | string | false | none | A value that can be applied to a custom field 4 that is part of the allocation form. |
| Custom16 | string | false | none | A value that can be applied to a custom field 5 that is part of the allocation form. |
| Custom17 | string | false | none | A value that can be applied to a custom field 6 that is part of the allocation form. |
| Custom18 | string | false | none | A value that can be applied to a custom field 7 that is part of the allocation form. |
| Custom19 | string | false | none | A value that can be applied to a custom field 8 that is part of the allocation form. |
| Custom20 | string | false | none | A value that can be applied to a custom field 9 that is part of the allocation form. |
| GrossAmount | string | false | none | Required. The allocation gross amount. |
| Percentage | string | false | none | Required. The allocation percentage. |
BillToAddress
{
"Address1": "string",
"Address2": "string",
"Address3": "string",
"City": "string",
"CountryCode": "string",
"ExternalID": "string",
"Name": "string",
"PostalCode": "string",
"State": "string",
"StateProvince": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Address1 | string | true | none | Required. Address line 1 of the shipping or billing address. |
| Address2 | string | false | none | Address line 2 of the shipping or billing address. |
| Address3 | string | false | none | Address line 3 of the shipping or billing address. |
| City | string | true | none | Required. The city of the shipping or billing address. |
| CountryCode | string | true | none | Required. The code of the country for the shipping or billing address. |
| ExternalID | string | true | none | Required. A unique value supplied by the customer to identify a particular shipping or billing address. |
| Name | string | false | none | An optional name that can be given to the shipping or billing address. |
| PostalCode | string | true | none | Required. The postal code of the shipping or billing address. |
| State | string | false | none | The state or province of the shipping or billing address. |
| StateProvince | string | false | none | Required. The state or province of the shipping or billing address. |
LineItem
{
"AccountCode": "string",
"Allocation": [
{
"Amount": "string",
"Custom1": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"GrossAmount": "string",
"Percentage": "string"
}
],
"AmountWithoutVat": "string",
"CreateDate": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Description": "string",
"ExpenseType": "string",
"ExternalID": "string",
"IsReceiptRequired": "string",
"LineNumber": "string",
"PurchaseOrderReceiptType": "string",
"Quantity": "string",
"RequestedBy": "string",
"RequestedDeliveryDate": "string",
"SupplierPartID": "string",
"Tax": "string",
"UnitOfMeasureCode": "string",
"UnitPrice": "string",
"VatAmount": "string",
"VatRate": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| AccountCode | string | false | none | The account code of the line item. A value must be supplied for either ExpenseType or AccountCode, but not both. This field is required if an ExpenseType value is not supplied. |
| Allocation | [Allocation] | false | none | none |
| AmountWithoutVat | string | false | none | The net amount of the line item (excluding VAT). |
| CreateDate | string | false | none | The date the line item was created. Format: YYYY-MM-DD |
| Custom1 | string | false | none | A value that can be applied to a custom field 1 that is part of the purchase order line item form. |
| Custom10 | string | false | none | A value that can be applied to a custom field 10 that is part of the purchase order line item form. |
| Custom11 | string | false | none | A value that can be applied to a custom field 11 that is part of the purchase order line item form. |
| Custom12 | string | false | none | A value that can be applied to a custom field 12 that is part of the purchase order line item form. |
| Custom13 | string | false | none | A value that can be applied to a custom field 13 that is part of the purchase order line item form. |
| Custom14 | string | false | none | A value that can be applied to a custom field 14 that is part of the purchase order line item form. |
| Custom15 | string | false | none | A value that can be applied to a custom field 15 that is part of the purchase order line item form. |
| Custom16 | string | false | none | A value that can be applied to a custom field 16 that is part of the purchase order line item form. |
| Custom17 | string | false | none | A value that can be applied to a custom field 17 that is part of the purchase order line item form. |
| Custom18 | string | false | none | A value that can be applied to a custom field 18 that is part of the purchase order line item form. |
| Custom19 | string | false | none | A value that can be applied to a custom field 19 that is part of the purchase order line item form. |
| Custom2 | string | false | none | A value that can be applied to a custom field 2 that is part of the purchase order line item form. |
| Custom20 | string | false | none | A value that can be applied to a custom field 20 that is part of the purchase order line item form. |
| Custom3 | string | false | none | A value that can be applied to a custom field 3 that is part of the purchase order line item form. |
| Custom4 | string | false | none | A value that can be applied to a custom field 4 that is part of the purchase order line item form. |
| Custom5 | string | false | none | A value that can be applied to a custom field 5 that is part of the purchase order line item form. |
| Custom6 | string | false | none | A value that can be applied to a custom field 6 that is part of the purchase order line item form. |
| Custom7 | string | false | none | A value that can be applied to a custom field 7 that is part of the purchase order line item form. |
| Custom8 | string | false | none | A value that can be applied to a custom field 8 that is part of the purchase order line item form. |
| Custom9 | string | false | none | A value that can be applied to a custom field 9 that is part of the purchase order line item form. |
| Description | string | false | none | A description of the line item. |
| ExpenseType | string | false | none | The expense type of the line item. A value must be supplied for either ExpenseType or AccountCode, but not both. This field is required if an AccountCode value is not supplied. |
| ExternalID | string | true | none | Required. A customer-supplied value that uniquely identifies the line item within the purchase order. |
| IsReceiptRequired | string | false | none | Indicates whether the line item requires a receipt. Format: true or false |
| LineNumber | string | true | none | Required. The line item number within the purchase order. |
| PurchaseOrderReceiptType | string | false | none | Purchase order ReceiptType of the line item. Accepted values are QUANTITY_RECEIPT or NONE. If a value is not provided, it will default to NONE. If you are using Concur Receiving and need to enter Goods Receipts against the resulting PO lines use QUANTITY_RECEIPT. |
| Quantity | string | true | none | Required. The quantity associated with the line item. |
| RequestedBy | string | false | none | The person who requests the goods in the line item of the purchase order. |
| RequestedDeliveryDate | string | false | none | The date the line item of the purchase order instructed the vendor to deliver the goods. Format: YYYY-MM-DD |
| SupplierPartID | string | false | none | Any number that might help to identify the line item. This could be a value such as the vendor's part number or even the manufacturer number. |
| Tax | string | false | none | Any tax that is associated with the line item. |
| UnitOfMeasureCode | string | false | none | The unit of measure code of the line item. |
| UnitPrice | string | true | none | Required. The price of each item of the line item. |
| VatAmount | string | false | none | This field has not been implemented by purchase request yet. Any data in this field will be ignored. |
| VatRate | string | false | none | This field has not been implemented by purchase request yet. Any data in this field will be ignored. |
PurchaseOrder
{
"AmountWithoutVat": "string",
"BillToAddress": {
"Address1": "string",
"Address2": "string",
"Address3": "string",
"City": "string",
"CountryCode": "string",
"ExternalID": "string",
"Name": "string",
"PostalCode": "string",
"State": "string",
"StateProvince": "string"
},
"CurrencyCode": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom21": "string",
"Custom22": "string",
"Custom23": "string",
"Custom24": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Description": "string",
"DiscountPercentage": "string",
"DiscountTerms": "string",
"ID": "string",
"IsTest": true,
"IsChangeOrder": true,
"LedgerCode": "string",
"LineItem": [
{
"AccountCode": "string",
"Allocation": [
{
"Amount": "string",
"Custom1": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"GrossAmount": "string",
"Percentage": "string"
}
],
"AmountWithoutVat": "string",
"CreateDate": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Description": "string",
"ExpenseType": "string",
"ExternalID": "string",
"IsReceiptRequired": "string",
"LineNumber": "string",
"PurchaseOrderReceiptType": "string",
"Quantity": "string",
"RequestedBy": "string",
"RequestedDeliveryDate": "string",
"SupplierPartID": "string",
"Tax": "string",
"UnitOfMeasureCode": "string",
"UnitPrice": "string",
"VatAmount": "string",
"VatRate": "string"
}
],
"Name": "string",
"NeededByDate": "string",
"OrderDate": "string",
"PaymentTerms": "string",
"PolicyExternalID": "string",
"PoVendorTaxId": "string",
"ProvincialTaxId": "string",
"PurchaseOrderNumber": "string",
"PurchaseRequestNumber": "string",
"ReceiptType": "string",
"RequestedBy": "string",
"RequestedDeliveryDate": "string",
"Shipping": "string",
"ShippingDescription": "string",
"ShippingMethodKey": "string",
"ShippingTermsKey": "string",
"ShipToAddress": {
"Address1": "string",
"Address2": "string",
"Address3": "string",
"City": "string",
"CountryCode": "string",
"ExternalID": "string",
"Name": "string",
"PostalCode": "string",
"State": "string",
"StateProvince": "string"
},
"Status": "string",
"Tax": "string",
"URI": "string",
"VatAmountOne": "string",
"VatAmountTwo": "string",
"VatRateOne": "string",
"VatRateTwo": "string",
"VendorAccountNumber": "string",
"VendorAddressCode": "string",
"VendorCode": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| AmountWithoutVat | string | false | none | The net amount of the purchase order, excluding VAT. |
| BillToAddress | BillToAddress | true | none | none |
| CurrencyCode | string | true | none | Required. The 3-letter ISO 4217 currency code of the currency that is associated with the purchase order. |
| Custom1 | string | false | none | A value that can be applied to a custom field 1 that is part of the purchase order header form. |
| Custom10 | string | false | none | A value that can be applied to a custom field 10 that is part of the purchase order header form. |
| Custom11 | string | false | none | A value that can be applied to a custom field 11 that is part of the purchase order header form. |
| Custom12 | string | false | none | A value that can be applied to a custom field 12 that is part of the purchase order header form. |
| Custom13 | string | false | none | A value that can be applied to a custom field 13 that is part of the purchase order header form. |
| Custom14 | string | false | none | A value that can be applied to a custom field 14 that is part of the purchase order header form. |
| Custom15 | string | false | none | A value that can be applied to a custom field 15 that is part of the purchase order header form. |
| Custom16 | string | false | none | A value that can be applied to a custom field 16 that is part of the purchase order header form. |
| Custom17 | string | false | none | A value that can be applied to a custom field 17 that is part of the purchase order header form. |
| Custom18 | string | false | none | A value that can be applied to a custom field 18 that is part of the purchase order header form. |
| Custom19 | string | false | none | A value that can be applied to a custom field 19 that is part of the purchase order header form. |
| Custom2 | string | false | none | A value that can be applied to a custom field 2 that is part of the purchase order header form. |
| Custom20 | string | false | none | A value that can be applied to a custom field 20 that is part of the purchase order header form. |
| Custom21 | string | false | none | A value that can be applied to a custom field 21 that is part of the purchase order header form. |
| Custom22 | string | false | none | A value that can be applied to a custom field 22 that is part of the purchase order header form. |
| Custom23 | string | false | none | A value that can be applied to a custom field 23 that is part of the purchase order header form. |
| Custom24 | string | false | none | A value that can be applied to a custom field 24 that is part of the purchase order header form. |
| Custom3 | string | false | none | A value that can be applied to a custom field 3 that is part of the purchase order header form. |
| Custom4 | string | false | none | A value that can be applied to a custom field 4 that is part of the purchase order header form. |
| Custom5 | string | false | none | A value that can be applied to a custom field 5 that is part of the purchase order header form. |
| Custom6 | string | false | none | A value that can be applied to a custom field 6 that is part of the purchase order header form. |
| Custom7 | string | false | none | A value that can be applied to a custom field 7 that is part of the purchase order header form. |
| Custom8 | string | false | none | A value that can be applied to a custom field 8 that is part of the purchase order header form. |
| Custom9 | string | false | none | A value that can be applied to a custom field 9 that is part of the purchase order header form. |
| Description | string | false | none | A description of the purchase order. |
| DiscountPercentage | string | false | none | The discount from the vendor, if the discount terms are met. |
| DiscountTerms | string | false | none | The net discount terms that the vendor offers, when discounts apply. |
| ID | string | false | none | The unique identifier of the resource. |
| IsTest | boolean | false | none | If the purchase order is a test. |
| IsChangeOrder | boolean | false | none | If the purchase order has a change order or not. |
| LedgerCode | string | false | none | A code which indicates which company journal the Purchase Order is assigned to. Use "GET /purchase order/localizeddata" to translate the code into text. |
| LineItem | [LineItem] | true | none | none |
| Name | string | false | none | Required. A name for the purchase order. |
| NeededByDate | string | false | none | The date by which the purchase order must be fulfilled. Format: YYYY-MM-DD |
| OrderDate | string | true | none | Required. The date when goods were ordered. Format: YYYY-MM-DD |
| PaymentTerms | string | false | none | The net payment terms that have been set up with a vendor. |
| PolicyExternalID | string | true | none | Required. The external identifier of the policy that should be associated with the purchase order. The external Id is a property of the policy configuration screen. Clients will need to get these ID’s from the Implementation team if using professional version. For standard version the value is always 'PO' |
| PoVendorTaxId | string | false | none | The vendor tax ID |
| ProvincialTaxId | string | false | none | The vendor provincial tax ID. |
| PurchaseOrderNumber | string | false | none | The purchase order number. |
| PurchaseRequestNumber | string | false | none | The related purchase request number that generated the purchase order. |
| ReceiptType | string | false | none | Deprecated, use the PurchaseOrderReceiptType at line item level instead. |
| RequestedBy | string | false | none | The person who requests the goods in the purchase order. |
| RequestedDeliveryDate | string | false | none | The date the purchase order instructed the vendor to deliver the goods. Format YYYY-MM-DD |
| Shipping | string | false | none | The total shipping cost for the purchase order. |
| ShippingDescription | string | false | none | A description of how the goods in the purchase order will ship. For example, via FedEx. |
| ShippingMethodKey | string | false | none | A code that represents the shipping method used by the vendor. Maximum length: 10 characters |
| ShippingTermsKey | string | false | none | A code that represents the shipping terms that the vendor offers. Maximum length: 10 characters |
| ShipToAddress | ShipToAddress | true | none | none |
| Status | string | false | none | The current status of the purchase order. Status should be either Closed or Transmitted. If a value is not provided, it will default to Transmitted. |
| Tax | string | false | none | The total tax for the purchase order. |
| URI | string | false | none | The URI to the resource. |
| VatAmountOne | string | false | none | This field has not been implemented by Purchase Request yet. Any data in this field will be ignored. |
| VatAmountTwo | string | false | none | This field has not been implemented by Purchase Request yet. Any data in this field will be ignored. |
| VatRateOne | string | false | none | This field has not been implemented by Purchase Request yet. Any data in this field will be ignored. |
| VatRateTwo | string | false | none | This field has not been implemented by Purchase Request yet. Any data in this field will be ignored. |
| VendorAccountNumber | string | false | none | The vendor account number. |
| VendorAddressCode | string | true | none | Required. The code that identifies the vendor's remit address for the purchase order. |
| VendorCode | string | true | none | Required. The code that identifies the vendor for the purchase order. |
PurchaseOrderResult
{
"ErrorCode": "string",
"ErrorMessage": "string",
"FieldCode": "string",
"LineItemExternalID": "string",
"Message": "string",
"PurchaseOrderNumber": "string",
"Status": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ErrorCode | string | false | none | A code that indicates why the purchase order was not processed successfully. |
| ErrorMessage | string | false | none | A description of the error. |
| FieldCode | string | false | none | A code that indicates which field caused an issue. This code typically appears only when a field is being validated against a field of a form type. Format: LEVEL |
| LineItemExternalID | string | false | none | The external ID of a line item that caused an error. If the error is related to an allocation, this field indicates the external ID of the line item that the allocation is associated with, and also indicates the allocation that caused of the error. |
| Message | string | false | none | Message of request result. |
| PurchaseOrderNumber | string | false | none | The purchase order number. |
| Status | string | false | none | The result of processing the purchase order. Format: SUCCESS or FAILURE |
ShipToAddress
{
"Address1": "string",
"Address2": "string",
"Address3": "string",
"City": "string",
"CountryCode": "string",
"ExternalID": "string",
"Name": "string",
"PostalCode": "string",
"State": "string",
"StateProvince": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Address1 | string | true | none | Required. Address line 1 of the shipping or billing address. |
| Address2 | string | false | none | Address line 2 of the shipping or billing address. |
| Address3 | string | false | none | Address line 3 of the shipping or billing address. |
| City | string | true | none | Required. The city of the shipping or billing address. |
| CountryCode | string | true | none | Required. The code of the country for the shipping or billing address. |
| ExternalID | string | true | none | Required. A unique value supplied by the customer to identify a particular shipping or billing address. |
| Name | string | false | none | An optional name that can be given to the shipping or billing address. |
| PostalCode | string | true | none | Required. The postal code of the shipping or billing address. |
| State | string | false | none | The state or province of the shipping or billing address. |
| StateProvince | string | false | none | Required. The state or province of the shipping or billing address. |
Void
{}
Properties
None
Receipt Images v3.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Allows for the management of receipt images attached to expense reports, expense entries, and payment requests. You can retrieve existing images by Image ID, and upload new images to a User. This API allows you to upload images in a predefined format and size targeting a specific resource or user in SAP Concur. You can also pull images down from SAP Concur by either displaying them in the browser or downloading the image content to save locally. Note: This API is not designed to obtain the receipt images attached to an expense report. If you are an Enterprise Partner creating integrations that are intended to obtain final-approved Expense or Invoice data, and the accompanying receipt images that substantiate those transactions you will need to use Image v1.
Base URLs:
Resources
get__expense_receiptimages
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/expense/receiptimages \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://www.concursolutions.com/api/v3.0/expense/receiptimages HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/receiptimages',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/expense/receiptimages',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/expense/receiptimages', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/expense/receiptimages', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/receiptimages");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/expense/receiptimages", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /expense/receiptimages
Get all receipt IDs by user
Get a list of all receipt IDs owned by the user associated with the access token
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| offset | query | string | false | Starting page offset |
| limit | query | integer(int32) | false | Number of records to return (default 25) |
| user | query | string | false | The login ID of the user. Optional. The user must have the Web Services Admin (Professional) or Can Administer (Standard) user role to use this parameter. |
Example responses
200 Response
{
"Items": {
"ID": "string",
"URI": "string"
},
"NextPage": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ReceiptImageCollection>
<Items>
<ID>string</ID>
<URI>string</URI>
</Items>
<NextPage>string</NextPage>
</ReceiptImageCollection>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ReceiptImageCollection |
post__expense_receiptimages
Code samples
# You can also use wget
curl -X POST https://www.concursolutions.com/api/v3.0/expense/receiptimages \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://www.concursolutions.com/api/v3.0/expense/receiptimages HTTP/1.1
Host: www.concursolutions.com
Content-Type: application/json
Accept: application/json
const inputBody = '{}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/receiptimages',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://www.concursolutions.com/api/v3.0/expense/receiptimages',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://www.concursolutions.com/api/v3.0/expense/receiptimages', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://www.concursolutions.com/api/v3.0/expense/receiptimages', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/receiptimages");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://www.concursolutions.com/api/v3.0/expense/receiptimages", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /expense/receiptimages
Create a receipt image
Upload a new receipt image.
Body parameter
{}
<?xml version="1.0" encoding="UTF-8" ?>
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| user | query | string | false | The login ID of the user. Optional. The user must have the Web Services Admin (Professional) or Can Administer (Standard) user role to use this parameter. |
| body | body | object | true | Image data file |
Example responses
200 Response
{
"ID": "string",
"URI": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ReceiptImage>
<ID>string</ID>
<URI>string</URI>
</ReceiptImage>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ReceiptImage |
| 400 | Bad Request | Bad Request | Void |
get_expense_receiptimages{id}
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/expense/receiptimages/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://www.concursolutions.com/api/v3.0/expense/receiptimages/{id} HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/receiptimages/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/expense/receiptimages/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/expense/receiptimages/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/expense/receiptimages/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/receiptimages/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/expense/receiptimages/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /expense/receiptimages/{id}
Get a receipt image URL
Get a receipt image URL by image ID.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | ReceiptImage ID |
| user | query | string | false | The login ID of the user. Optional. The user must have the Web Services Admin (Professional) or Can Administer (Standard) user role to use this parameter. |
Example responses
200 Response
{
"ID": "string",
"URI": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ReceiptImage>
<ID>string</ID>
<URI>string</URI>
</ReceiptImage>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ReceiptImage |
put_expense_receiptimages{id}
Code samples
# You can also use wget
curl -X PUT https://www.concursolutions.com/api/v3.0/expense/receiptimages/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
PUT https://www.concursolutions.com/api/v3.0/expense/receiptimages/{id} HTTP/1.1
Host: www.concursolutions.com
Content-Type: application/json
Accept: application/json
const inputBody = '{}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/receiptimages/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put 'https://www.concursolutions.com/api/v3.0/expense/receiptimages/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('https://www.concursolutions.com/api/v3.0/expense/receiptimages/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','https://www.concursolutions.com/api/v3.0/expense/receiptimages/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/receiptimages/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://www.concursolutions.com/api/v3.0/expense/receiptimages/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /expense/receiptimages/{id}
Append a receipt image
Appends a receipt image to an existing image. The resulting image will be a consolidated PDF.
Body parameter
{}
<?xml version="1.0" encoding="UTF-8" ?>
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | ID of the receipt image to update |
| user | query | string | false | The login ID of the user. Optional. The user must have the Web Services Admin (Professional) or Can Administer (Standard) user role to use this parameter. |
| body | body | object | true | Image data file |
Example responses
200 Response
{}
<?xml version="1.0" encoding="UTF-8" ?>
<Void/>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Void |
| 400 | Bad Request | Bad Request | Void |
delete_expense_receiptimages{id}
Code samples
# You can also use wget
curl -X DELETE https://www.concursolutions.com/api/v3.0/expense/receiptimages/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
DELETE https://www.concursolutions.com/api/v3.0/expense/receiptimages/{id} HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/receiptimages/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://www.concursolutions.com/api/v3.0/expense/receiptimages/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://www.concursolutions.com/api/v3.0/expense/receiptimages/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','https://www.concursolutions.com/api/v3.0/expense/receiptimages/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/receiptimages/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://www.concursolutions.com/api/v3.0/expense/receiptimages/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /expense/receiptimages/{id}
Delete a receipt image by ID
Deletes the specified receipt image
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | ID of the receipt image to delete |
| user | query | string | false | The login ID of the user. Optional. The user must have the Web Services Admin (Professional) or Can Administer (Standard) user role to use this parameter. |
Example responses
200 Response
{}
<?xml version="1.0" encoding="UTF-8" ?>
<Void/>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Void |
| 400 | Bad Request | Bad Request | Void |
Schemas
ReceiptImage
{
"ID": "string",
"URI": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ID | string | false | none | The unique identifier of the resource. |
| URI | string | false | none | The URI to the resource. |
ReceiptImageCollection
{
"Items": {
"ID": "string",
"URI": "string"
},
"NextPage": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Items | ReceiptImage | false | none | none |
| NextPage | string | false | none | The URI of the next page of results, if any. |
Void
{}
Properties
None
Receipts v3.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Base URLs:
Resources
post__common_receipts
Code samples
# You can also use wget
curl -X POST https://www.concursolutions.com/api/v3.0/common/receipts \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
POST https://www.concursolutions.com/api/v3.0/common/receipts HTTP/1.1
Host: www.concursolutions.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"Amount": 0,
"CurrencyCode": "string",
"CustomFields": {
"Name": "string",
"Value": "string"
},
"FormofPaymentCode": "string",
"GeneralDetail": {
"LineItems": {
"Amount": 0,
"Date": "2019-08-24T14:15:22Z",
"Description": "string",
"Description2": "string",
"Quantity": 0,
"Rate": 0,
"RateType": "string",
"Reference": "string",
"SequenceNumber": 0
}
},
"HotelDetail": {
"AverageDailyRoomRate": 0,
"CheckinDateTime": "2019-08-24T14:15:22Z",
"CheckoutDateTime": "2019-08-24T14:15:22Z",
"ConfirmationNumber": "string",
"GNR": "string",
"LineItems": {
"Amount": 0,
"Date": "2019-08-24T14:15:22Z",
"Description": "string",
"Description2": "string",
"Quantity": 0,
"Rate": 0,
"RateType": "string",
"Reference": "string",
"SequenceNumber": 0
},
"NumberInParty": 0,
"RatePlanType": "string",
"RoomNumber": "string",
"RoomType": "string"
},
"ImageBase64": "string",
"MatchingFact": {
"Type": "string",
"Value": "string"
},
"Merchant": {
"Location": {
"Address": "string",
"Address2": "string",
"City": "string",
"CountryCode": "string",
"CountrySubdivisionCode": "string",
"EmailAddress": "string",
"FaxNumber": "string",
"InternetAddress": "string",
"Name": "string",
"PostalCode": "string",
"TelephoneNumber": "string"
},
"Name": "string"
},
"PaymentCard": {
"AuthorizationCode": "string",
"MaskedNumber": "string",
"Type": "string"
},
"RideDetail": {
"DriverName": "string",
"DropoffLatitude": 0,
"DropoffLongitude": 0,
"EndDateTime": "2019-08-24T14:15:22Z",
"LineItems": {
"Amount": 0,
"Date": "2019-08-24T14:15:22Z",
"Description": "string",
"Description2": "string",
"Quantity": 0,
"Rate": 0,
"RateType": "string",
"Reference": "string",
"SequenceNumber": 0
},
"StartDateTime": "2019-08-24T14:15:22Z",
"VehicleNumber": "string"
},
"TransactionDateTime": "2019-08-24T14:15:22Z",
"Type": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://www.concursolutions.com/api/v3.0/common/receipts',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://www.concursolutions.com/api/v3.0/common/receipts',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://www.concursolutions.com/api/v3.0/common/receipts', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://www.concursolutions.com/api/v3.0/common/receipts', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/common/receipts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://www.concursolutions.com/api/v3.0/common/receipts", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /common/receipts
Create a new receipt entry
Creates a new receipt entry. This operation enables a provider company to post receipts to Concur.
Body parameter
{
"Amount": 0,
"CurrencyCode": "string",
"CustomFields": {
"Name": "string",
"Value": "string"
},
"FormofPaymentCode": "string",
"GeneralDetail": {
"LineItems": {
"Amount": 0,
"Date": "2019-08-24T14:15:22Z",
"Description": "string",
"Description2": "string",
"Quantity": 0,
"Rate": 0,
"RateType": "string",
"Reference": "string",
"SequenceNumber": 0
}
},
"HotelDetail": {
"AverageDailyRoomRate": 0,
"CheckinDateTime": "2019-08-24T14:15:22Z",
"CheckoutDateTime": "2019-08-24T14:15:22Z",
"ConfirmationNumber": "string",
"GNR": "string",
"LineItems": {
"Amount": 0,
"Date": "2019-08-24T14:15:22Z",
"Description": "string",
"Description2": "string",
"Quantity": 0,
"Rate": 0,
"RateType": "string",
"Reference": "string",
"SequenceNumber": 0
},
"NumberInParty": 0,
"RatePlanType": "string",
"RoomNumber": "string",
"RoomType": "string"
},
"ImageBase64": "string",
"MatchingFact": {
"Type": "string",
"Value": "string"
},
"Merchant": {
"Location": {
"Address": "string",
"Address2": "string",
"City": "string",
"CountryCode": "string",
"CountrySubdivisionCode": "string",
"EmailAddress": "string",
"FaxNumber": "string",
"InternetAddress": "string",
"Name": "string",
"PostalCode": "string",
"TelephoneNumber": "string"
},
"Name": "string"
},
"PaymentCard": {
"AuthorizationCode": "string",
"MaskedNumber": "string",
"Type": "string"
},
"RideDetail": {
"DriverName": "string",
"DropoffLatitude": 0,
"DropoffLongitude": 0,
"EndDateTime": "2019-08-24T14:15:22Z",
"LineItems": {
"Amount": 0,
"Date": "2019-08-24T14:15:22Z",
"Description": "string",
"Description2": "string",
"Quantity": 0,
"Rate": 0,
"RateType": "string",
"Reference": "string",
"SequenceNumber": 0
},
"StartDateTime": "2019-08-24T14:15:22Z",
"VehicleNumber": "string"
},
"TransactionDateTime": "2019-08-24T14:15:22Z",
"Type": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ReceiptPost>
<Amount>0</Amount>
<CurrencyCode>string</CurrencyCode>
<CustomFields>
<Name>string</Name>
<Value>string</Value>
</CustomFields>
<FormofPaymentCode>string</FormofPaymentCode>
<GeneralDetail>
<LineItems>
<Amount>0</Amount>
<Date>2019-08-24T14:15:22Z</Date>
<Description>string</Description>
<Description2>string</Description2>
<Quantity>0</Quantity>
<Rate>0</Rate>
<RateType>string</RateType>
<Reference>string</Reference>
<SequenceNumber>0</SequenceNumber>
</LineItems>
</GeneralDetail>
<HotelDetail>
<AverageDailyRoomRate>0</AverageDailyRoomRate>
<CheckinDateTime>2019-08-24T14:15:22Z</CheckinDateTime>
<CheckoutDateTime>2019-08-24T14:15:22Z</CheckoutDateTime>
<ConfirmationNumber>string</ConfirmationNumber>
<GNR>string</GNR>
<LineItems>
<Amount>0</Amount>
<Date>2019-08-24T14:15:22Z</Date>
<Description>string</Description>
<Description2>string</Description2>
<Quantity>0</Quantity>
<Rate>0</Rate>
<RateType>string</RateType>
<Reference>string</Reference>
<SequenceNumber>0</SequenceNumber>
</LineItems>
<NumberInParty>0</NumberInParty>
<RatePlanType>string</RatePlanType>
<RoomNumber>string</RoomNumber>
<RoomType>string</RoomType>
</HotelDetail>
<ImageBase64>string</ImageBase64>
<MatchingFact>
<Type>string</Type>
<Value>string</Value>
</MatchingFact>
<Merchant>
<Location>
<Address>string</Address>
<Address2>string</Address2>
<City>string</City>
<CountryCode>string</CountryCode>
<CountrySubdivisionCode>string</CountrySubdivisionCode>
<EmailAddress>string</EmailAddress>
<FaxNumber>string</FaxNumber>
<InternetAddress>string</InternetAddress>
<Name>string</Name>
<PostalCode>string</PostalCode>
<TelephoneNumber>string</TelephoneNumber>
</Location>
<Name>string</Name>
</Merchant>
<PaymentCard>
<AuthorizationCode>string</AuthorizationCode>
<MaskedNumber>string</MaskedNumber>
<Type>string</Type>
</PaymentCard>
<RideDetail>
<DriverName>string</DriverName>
<DropoffLatitude>0</DropoffLatitude>
<DropoffLongitude>0</DropoffLongitude>
<EndDateTime>2019-08-24T14:15:22Z</EndDateTime>
<LineItems>
<Amount>0</Amount>
<Date>2019-08-24T14:15:22Z</Date>
<Description>string</Description>
<Description2>string</Description2>
<Quantity>0</Quantity>
<Rate>0</Rate>
<RateType>string</RateType>
<Reference>string</Reference>
<SequenceNumber>0</SequenceNumber>
</LineItems>
<StartDateTime>2019-08-24T14:15:22Z</StartDateTime>
<VehicleNumber>string</VehicleNumber>
</RideDetail>
<TransactionDateTime>2019-08-24T14:15:22Z</TransactionDateTime>
<Type>string</Type>
</ReceiptPost>
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | ReceiptPost | true | The Receipt object to create. |
Example responses
200 Response
{
"ID": "string",
"URI": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CreateResponse>
<ID>string</ID>
<URI>string</URI>
</CreateResponse>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | CreateResponse |
Schemas
CreateResponse
{
"ID": "string",
"URI": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ID | string | false | none | none |
| URI | string | false | none | none |
CustomField
{
"Name": "string",
"Value": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Name | string | false | none | The name of the custom field. Maximum length: 128 characters |
| Value | string | false | none | The value of the custom field. Maximum length: 256 characters |
Decimal
{}
Properties
None
GeneralDetail
{
"LineItems": {
"Amount": 0,
"Date": "2019-08-24T14:15:22Z",
"Description": "string",
"Description2": "string",
"Quantity": 0,
"Rate": 0,
"RateType": "string",
"Reference": "string",
"SequenceNumber": 0
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| LineItems | LineItem | false | none | none |
HotelDetail
{
"AverageDailyRoomRate": 0,
"CheckinDateTime": "2019-08-24T14:15:22Z",
"CheckoutDateTime": "2019-08-24T14:15:22Z",
"ConfirmationNumber": "string",
"GNR": "string",
"LineItems": {
"Amount": 0,
"Date": "2019-08-24T14:15:22Z",
"Description": "string",
"Description2": "string",
"Quantity": 0,
"Rate": 0,
"RateType": "string",
"Reference": "string",
"SequenceNumber": 0
},
"NumberInParty": 0,
"RatePlanType": "string",
"RoomNumber": "string",
"RoomType": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| AverageDailyRoomRate | number(double) | false | none | The sum of the room rate for each night stayed, divided by the number of nights stayed. Range: -922,337,203,685,477 to 922,337,203,685,477 |
| CheckinDateTime | string(date-time) | false | none | The check-in date and time. Format: YYYY-MM-DDThh:mm |
| CheckoutDateTime | string(date-time) | false | none | The check-out date and time. Format: YYYY-MM-DDThh:mm |
| ConfirmationNumber | string | false | none | The confirmation number for the booking. Maximum length: 32 characters |
| GNR | string | false | none | The Guest Name Record (GNR) for the stay. Maximum length: 20 characters |
| LineItems | LineItem | false | none | none |
| NumberInParty | integer(int32) | false | none | The number of people for this stay. |
| RatePlanType | string | false | none | The rate plan type that is used to calculate the room rate. Possible values are rate plan types defined using hospitality industry standards. Maximum length: 50 characters |
| RoomNumber | string | false | none | The room number for the stay. Maximum length: 15 characters |
| RoomType | string | false | none | The type of room. Possible values are room types defined using hospitality industry standards, such as Single, Double, Suite, and so on. Maximum length: 50 characters |
LineItem
{
"Amount": 0,
"Date": "2019-08-24T14:15:22Z",
"Description": "string",
"Description2": "string",
"Quantity": 0,
"Rate": 0,
"RateType": "string",
"Reference": "string",
"SequenceNumber": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Amount | number(double) | false | none | The total charged amount for the line item. Range: -922,337,203,685,477 to 922,337,203,685,477 |
| Date | string(date-time) | false | none | The date and time when the line item was charged. Format: YYYY-MM-DDThh:mm |
| Description | string | false | none | The item's description. Maximum length: 100 characters |
| Description2 | string | false | none | Additional details about the item. In the receipt image, the secondary description appears on the line following the primary description. Maximum length: 32 characters |
| Quantity | integer(int32) | false | none | The quantity of units. Format: Any positive number |
| Rate | number(double) | false | none | The amount charged per unit. Range: -922,337,203,685,477 to 922,337,203,685,477 |
| RateType | string | false | none | The unit of measure or rate type. Possible values: HOUR or PER HOUR, DAY or PER DAY, WEEK or PER WEEK, MONTH or PER MONTH. Maximum length: 10 characters |
| Reference | string | false | none | The item's SKU, identifier, or some other attribute the provider uses to reference the item. Maximum length: 32 characters |
| SequenceNumber | integer(int32) | false | none | The order in which the item appears in the sequence of line items. |
Location
{
"Address": "string",
"Address2": "string",
"City": "string",
"CountryCode": "string",
"CountrySubdivisionCode": "string",
"EmailAddress": "string",
"FaxNumber": "string",
"InternetAddress": "string",
"Name": "string",
"PostalCode": "string",
"TelephoneNumber": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Address | string | false | none | The provider's street address. Maximum length: 100 characters |
| Address2 | string | false | none | The provider's secondary street address. Maximum length: 50 characters |
| City | string | false | none | The provider's city. Maximum length: 100 characters |
| CountryCode | string | false | none | The provider's country. Format: 2-letter ISO 3166-1 country code |
| CountrySubdivisionCode | string | false | none | The provider's state, province, or other country subdivision. Format: ISO 3166-2:2007 country subdivision code YYY, where YYY is the one-to-three–character subdivision code |
| EmailAddress | string | false | none | The provider's email address. Maximum length: 255 characters |
| FaxNumber | string | false | none | The provider's fax number. Maximum length: 32 characters |
| InternetAddress | string | false | none | The provider's Web address. Maximum length: 255 characters |
| Name | string | false | none | The name of the provider's location, such as an airport, car rental agency, property, store, or other named location. Maximum length: 100 characters |
| PostalCode | string | false | none | The provider's postal code. Maximum length: 20 characters |
| TelephoneNumber | string | false | none | The provider's telephone number. Maximum length: 100 characters |
MatchingFact
{
"Type": "string",
"Value": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Type | string | false | none | The type of matching fact that is used to identify the Concur user who owns the receipt. Possible values: OAuth, Login |
| Value | string | false | none | The value of the matching fact. If the Type element is set to OAuth, this value must be the access token for the Concur user who owns the receipt. In this case, the access token must not be expired or revoked. If the Type element is set to Login, this value must be the login ID of the Concur user who owns the receipt. |
Merchant
{
"Location": {
"Address": "string",
"Address2": "string",
"City": "string",
"CountryCode": "string",
"CountrySubdivisionCode": "string",
"EmailAddress": "string",
"FaxNumber": "string",
"InternetAddress": "string",
"Name": "string",
"PostalCode": "string",
"TelephoneNumber": "string"
},
"Name": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Location | Location | false | none | none |
| Name | string | false | none | The name of the provider (merchant). Maximum length: 64 characters |
PaymentCard
{
"AuthorizationCode": "string",
"MaskedNumber": "string",
"Type": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| AuthorizationCode | string | false | none | The authorization code that the card interchange provided when it approved this purchase. Maximum length: 15 characters |
| MaskedNumber | string | false | none | The masked card number for the credit card. With the exception of the AX (American Express) card type, this is the last four digits of the card number. For American Express, the value can be one of these, in order of preference: a) The first six digits and the last four digits of the card number. b) The last five digits. c) The last four digits. |
| Type | string | false | none | The card interchange for the credit card. Possible values: AX (American Express), DC (Diner's Club), DS (Discover), CA (MasterCard), VI (Visa), CB (Carte Blanche), ER (Enroute), TP (Universal Air Travel), JC (JCB), EC (EuroCard), OTHER (other types) |
ReceiptPost
{
"Amount": 0,
"CurrencyCode": "string",
"CustomFields": {
"Name": "string",
"Value": "string"
},
"FormofPaymentCode": "string",
"GeneralDetail": {
"LineItems": {
"Amount": 0,
"Date": "2019-08-24T14:15:22Z",
"Description": "string",
"Description2": "string",
"Quantity": 0,
"Rate": 0,
"RateType": "string",
"Reference": "string",
"SequenceNumber": 0
}
},
"HotelDetail": {
"AverageDailyRoomRate": 0,
"CheckinDateTime": "2019-08-24T14:15:22Z",
"CheckoutDateTime": "2019-08-24T14:15:22Z",
"ConfirmationNumber": "string",
"GNR": "string",
"LineItems": {
"Amount": 0,
"Date": "2019-08-24T14:15:22Z",
"Description": "string",
"Description2": "string",
"Quantity": 0,
"Rate": 0,
"RateType": "string",
"Reference": "string",
"SequenceNumber": 0
},
"NumberInParty": 0,
"RatePlanType": "string",
"RoomNumber": "string",
"RoomType": "string"
},
"ImageBase64": "string",
"MatchingFact": {
"Type": "string",
"Value": "string"
},
"Merchant": {
"Location": {
"Address": "string",
"Address2": "string",
"City": "string",
"CountryCode": "string",
"CountrySubdivisionCode": "string",
"EmailAddress": "string",
"FaxNumber": "string",
"InternetAddress": "string",
"Name": "string",
"PostalCode": "string",
"TelephoneNumber": "string"
},
"Name": "string"
},
"PaymentCard": {
"AuthorizationCode": "string",
"MaskedNumber": "string",
"Type": "string"
},
"RideDetail": {
"DriverName": "string",
"DropoffLatitude": 0,
"DropoffLongitude": 0,
"EndDateTime": "2019-08-24T14:15:22Z",
"LineItems": {
"Amount": 0,
"Date": "2019-08-24T14:15:22Z",
"Description": "string",
"Description2": "string",
"Quantity": 0,
"Rate": 0,
"RateType": "string",
"Reference": "string",
"SequenceNumber": 0
},
"StartDateTime": "2019-08-24T14:15:22Z",
"VehicleNumber": "string"
},
"TransactionDateTime": "2019-08-24T14:15:22Z",
"Type": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Amount | number(double) | false | none | The net amount of the transaction. A positive number means a payment is due. A negative number means a refund is due. Zero means no payment or refund is due. Range: -922,337,203,685,477 to 922,337,203,685,477 |
| CurrencyCode | string | false | none | The 3-letter ISO 4217 currency code for the currency paid to the provider. |
| CustomFields | CustomField | false | none | none |
| FormofPaymentCode | string | false | none | The code for the form of payment. Possible values: CASH (Cash), CCARD (Credit Card), CPAID (Company Paid) |
| GeneralDetail | GeneralDetail | false | none | none |
| HotelDetail | HotelDetail | false | none | none |
| ImageBase64 | string | false | none | The binary receipt image in Base64 encoding. This API supports PNG, JPEG, JPG, and PDF file formats. |
| MatchingFact | MatchingFact | false | none | none |
| Merchant | Merchant | false | none | none |
| PaymentCard | PaymentCard | false | none | none |
| RideDetail | RideDetail | false | none | none |
| TransactionDateTime | string(date-time) | false | none | The date and time when the transaction happened. Format: YYYY-MM-DDThh:mm |
| Type | string | false | none | The type of receipt. Possible values: General, Ride, Hotel |
RideDetail
{
"DriverName": "string",
"DropoffLatitude": 0,
"DropoffLongitude": 0,
"EndDateTime": "2019-08-24T14:15:22Z",
"LineItems": {
"Amount": 0,
"Date": "2019-08-24T14:15:22Z",
"Description": "string",
"Description2": "string",
"Quantity": 0,
"Rate": 0,
"RateType": "string",
"Reference": "string",
"SequenceNumber": 0
},
"StartDateTime": "2019-08-24T14:15:22Z",
"VehicleNumber": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| DriverName | string | false | none | The name of the driver. Maximum length: 255 characters |
| DropoffLatitude | number(double) | false | none | The latitude of the ride end location. Range: -90 to 90 |
| DropoffLongitude | number(double) | false | none | The longitude of the ride end location. Range: -180 to 180 |
| EndDateTime | string(date-time) | false | none | The ending date and time for the ride. Format: YYYY-MM-DDThh:mm |
| LineItems | LineItem | false | none | none |
| StartDateTime | string(date-time) | false | none | The starting date and time for the ride. Format: YYYY-MM-DDThh:mm |
| VehicleNumber | string | false | none | The unique identifier for the vehicle. Maximum length: 50 characters |
Nullable_1
{
"HasValue": true,
"Value": {}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| HasValue | boolean | false | none | none |
| Value | Decimal | false | none | none |
Reports v3.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Get expense reports for a user or company, and update existing reports or create new reports.
Base URLs:
oAuth2 authentication. To use this API, you need to get OAuth client credentials (client ID, secret, and geolocation) from SAP Concur, and be authorized to use the relevant scope. Refer to the full authentication inFormation for more inFormation.
Resources
get__expense_reports
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/expense/reports \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://www.concursolutions.com/api/v3.0/expense/reports HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/reports',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/expense/reports',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/expense/reports', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/expense/reports', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/reports");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/expense/reports", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /expense/reports
Gets all reports
Returns all reports owned by the user based on the search criteria.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| offset | query | string | false | Starting page offset |
| limit | query | integer(int32) | false | Number of records to return (default 25) |
| user | query | string | false | Optional. The login ID of the report owner(s) to use when searching for reports. If the value is set to LoginID, reports for the report owner with this login ID value are returned. If the value is set to ALL, reports for all report owners are returned. If this parameter is not specified, reports for the OAuth Consumer are returned. The access token owner (OAuth Consumer) must have the Web Services Admin role to use this parameter. |
| approvalStatusCode | query | string | false | The status code for the Approval Status. The values can include Concur Expense standard codes or custom codes. The Concur Expense standard code values are: A_AAFH - Report submission triggered an anomaly and fraud check; A_ACCO - Report is pending reviews; A_APPR - Report has been approved; A_EXTV - Report is pending external validation; A_FILE - Report has been submitted; A_NOTF - Report has not been submitted; A_PBDG - Report approval is pending Budget approval; A_PECO - Report approval is pending Cost object approval; A_PEND - Report is pending manager approval; A_PVAL - Report is pending prepayment validation; A_RESU - Report needs to be resubmitted; A_RHLD - Report submission is pending receipt images; A_TEXP - Report expired in approval queue. For custom codes, contact Concur Developer Support. |
| paymentStatusCode | query | string | false | The payment status code for the report. The values can include Concur Expense standard codes or custom codes. The Concur Expense standard code values are: P_HOLD - Report payment is on hold; P_NOTP - Report has not been paid; P_PAID - Report has been paid; P_PAYC - Payment is confirmed. Some or all of the report expenses have been paid; P_PROC - Report is in process to be paid. For custom codes, contact Concur Developer Support. |
| currencyCode | query | string | false | The 3-letter ISO 4217 currency code for the report currency. Example: USD. |
| paymentType | query | string | false | The unique identifier for the payment type that is the payment type for at least one expense entry in the report. Use PaymentTypeID from the "GET Expense Group Configurations" function. |
| reimbursementMethod | query | string | false | The method the report owner will be reimbursed. VALUES: ADPPAYR - ADP Payroll; APCHECK - AP (Company Check); CNQRPAY - Expense Pay; PMTSERV - Other Payment Service. NOTE: PAY_PAL is NOT supported. |
| approverLoginID | query | string | false | The login ID for the report approver that is the current approver assigned to the report. |
| expenseTypeCode | query | string | false | The expense type code that is the expense type for at least one expense entry in the report. Use ExpenseTypeCode from the "GET Expense Group Configurations" function. |
| attendeeTypeCode | query | string | false | The report contains expense entries that have attendees of the specified type. |
| countryCode | query | string | false | The report country. Maximum 2 characters. Format: The ISO 3166-1 alpha-2 country code. Example: United States is US. |
| batchID | query | string | false | The unique identifier for a payment batch where there is at least one report payee within the report. Use the BatchID from the "GET Payment Batch List" function. |
| vendorName | query | string | false | The Vendor Description that is the vendor for at least one expense entry in the report. |
| hasVAT | query | boolean | false | Determines if the report has at least one expense entry with VAT details. Format: true or false. |
| hasImages | query | boolean | false | Determines if the report has at least one expense entry with an entry image or if there is a report image for this report. Format: true or false. |
| hasAttendees | query | boolean | false | Determines if the report has at least one expense entry with an attendee. Format: true or false. |
| hasBillableExpenses | query | boolean | false | The IsBillable flag for at least one expense entry in the report. Format: true or false. |
| isTestUser | query | boolean | false | The report owner is a test user using the report for testing purposes in a non-production envirnment. format: true or false. |
| expenseGroupConfigID | query | string | false | The unique identifier for the expense group configuration associated to the report's expense group. Use the ID from the "GET Expense Group Configurations" function. |
| entryTransactionDateBefore | query | string(date-time) | false | The entry transaction date for at least one expense entry in the report is before this date.Format: YYYY-MM-DD |
| entryTransactionDateAfter | query | string(date-time) | false | The entry transaction date for at least one expense entry in the report is after this date.Format: YYYY-MM-DD |
| createDateBefore | query | string(date-time) | false | The report create date is before this date.Format: YYYY-MM-DD |
| createDateAfter | query | string(date-time) | false | The report create date is after this date.Format: YYYY-MM-DD |
| userDefinedDateBefore | query | string(date-time) | false | The report user defined date is before this date.Format: YYYY-MM-DD |
| userDefinedDateAfter | query | string(date-time) | false | The report user defined date is after this date.Format: YYYY-MM-DD |
| submitDateBefore | query | string(date-time) | false | The report submit date is before this date.Format: YYYY-MM-DD |
| submitDateAfter | query | string(date-time) | false | The report submit date is after this date.Format: YYYY-MM-DD |
| processingPaymentDateBefore | query | string(date-time) | false | The report processing payment date is before this date.Format: YYYY-MM-DD |
| processingPaymentDateAfter | query | string(date-time) | false | The report processing payment date is after this date. Format: YYYY-MM-DD |
| paidDateBefore | query | string(date-time) | false | The report paid date is before this date.Format: YYYY-MM-DD |
| paidDateAfter | query | string(date-time) | false | The report paid date is after this date.Format: YYYY-MM-DD |
| modifiedDateBefore | query | string(date-time) | false | The report modified date is before this date.Format: YYYY-MM-DD |
| modifiedDateAfter | query | string(date-time) | false | The report modified date is after this date.Format: YYYY-MM-DD |
Example responses
200 Response
{
"Items": {
"AmountDueCompanyCard": 0,
"AmountDueEmployee": 0,
"ApprovalStatusCode": "string",
"ApprovalStatusName": "string",
"ApproverLoginID": "string",
"ApproverName": "string",
"Country": "string",
"CountrySubdivision": "string",
"CreateDate": "2019-08-24T14:15:22Z",
"CurrencyCode": "string",
"Custom1": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom2": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom3": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom4": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom5": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom6": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom7": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom8": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom9": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom10": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom11": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom12": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom13": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom14": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom15": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom16": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom17": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom18": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom19": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom20": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"EverSentBack": true,
"HasException": true,
"ID": "string",
"LastComment": "string",
"LastModifiedDate": "2019-08-24T14:15:22Z",
"LedgerName": "string",
"Name": "string",
"OrgUnit1": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit2": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit3": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit4": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit5": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit6": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OwnerLoginID": "string",
"OwnerName": "string",
"PaidDate": "2019-08-24T14:15:22Z",
"PaymentStatusCode": "string",
"PaymentStatusName": "string",
"PersonalAmount": 0,
"PolicyID": "string",
"ProcessingPaymentDate": "2019-08-24T14:15:22Z",
"ReceiptsReceived": true,
"SubmitDate": "2019-08-24T14:15:22Z",
"Total": 0,
"TotalApprovedAmount": 0,
"TotalClaimedAmount": 0,
"URI": "string",
"UserDefinedDate": "2019-08-24T14:15:22Z",
"WorkflowActionUrl": "string"
},
"NextPage": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ReportCollection>
<Items>
<AmountDueCompanyCard>0</AmountDueCompanyCard>
<AmountDueEmployee>0</AmountDueEmployee>
<ApprovalStatusCode>string</ApprovalStatusCode>
<ApprovalStatusName>string</ApprovalStatusName>
<ApproverLoginID>string</ApproverLoginID>
<ApproverName>string</ApproverName>
<Country>string</Country>
<CountrySubdivision>string</CountrySubdivision>
<CreateDate>2019-08-24T14:15:22Z</CreateDate>
<CurrencyCode>string</CurrencyCode>
<Custom1>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom1>
<Custom2>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom2>
<Custom3>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom3>
<Custom4>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom4>
<Custom5>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom5>
<Custom6>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom6>
<Custom7>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom7>
<Custom8>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom8>
<Custom9>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom9>
<Custom10>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom10>
<Custom11>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom11>
<Custom12>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom12>
<Custom13>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom13>
<Custom14>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom14>
<Custom15>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom15>
<Custom16>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom16>
<Custom17>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom17>
<Custom18>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom18>
<Custom19>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom19>
<Custom20>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom20>
<EverSentBack>true</EverSentBack>
<HasException>true</HasException>
<ID>string</ID>
<LastComment>string</LastComment>
<LastModifiedDate>2019-08-24T14:15:22Z</LastModifiedDate>
<LedgerName>string</LedgerName>
<Name>string</Name>
<OrgUnit1>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</OrgUnit1>
<OrgUnit2>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</OrgUnit2>
<OrgUnit3>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</OrgUnit3>
<OrgUnit4>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</OrgUnit4>
<OrgUnit5>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</OrgUnit5>
<OrgUnit6>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</OrgUnit6>
<OwnerLoginID>string</OwnerLoginID>
<OwnerName>string</OwnerName>
<PaidDate>2019-08-24T14:15:22Z</PaidDate>
<PaymentStatusCode>string</PaymentStatusCode>
<PaymentStatusName>string</PaymentStatusName>
<PersonalAmount>0</PersonalAmount>
<PolicyID>string</PolicyID>
<ProcessingPaymentDate>2019-08-24T14:15:22Z</ProcessingPaymentDate>
<ReceiptsReceived>true</ReceiptsReceived>
<SubmitDate>2019-08-24T14:15:22Z</SubmitDate>
<Total>0</Total>
<TotalApprovedAmount>0</TotalApprovedAmount>
<TotalClaimedAmount>0</TotalClaimedAmount>
<URI>string</URI>
<UserDefinedDate>2019-08-24T14:15:22Z</UserDefinedDate>
<WorkflowActionUrl>string</WorkflowActionUrl>
</Items>
<NextPage>string</NextPage>
</ReportCollection>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ReportCollection |
post__expense_reports
Code samples
# You can also use wget
curl -X POST https://www.concursolutions.com/api/v3.0/expense/reports \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://www.concursolutions.com/api/v3.0/expense/reports HTTP/1.1
Host: www.concursolutions.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"Comment": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Name": "string",
"OrgUnit1": "string",
"OrgUnit2": "string",
"OrgUnit3": "string",
"OrgUnit4": "string",
"OrgUnit5": "string",
"OrgUnit6": "string",
"PolicyID": "string",
"Purpose": "string",
"UserDefinedDate": "2019-08-24T14:15:22Z"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/reports',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://www.concursolutions.com/api/v3.0/expense/reports',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://www.concursolutions.com/api/v3.0/expense/reports', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://www.concursolutions.com/api/v3.0/expense/reports', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/reports");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://www.concursolutions.com/api/v3.0/expense/reports", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /expense/reports
Create a new report
Create an expense report with the supplied data.
Body parameter
{
"Comment": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Name": "string",
"OrgUnit1": "string",
"OrgUnit2": "string",
"OrgUnit3": "string",
"OrgUnit4": "string",
"OrgUnit5": "string",
"OrgUnit6": "string",
"PolicyID": "string",
"Purpose": "string",
"UserDefinedDate": "2019-08-24T14:15:22Z"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ReportPost>
<Comment>string</Comment>
<Custom1>string</Custom1>
<Custom10>string</Custom10>
<Custom11>string</Custom11>
<Custom12>string</Custom12>
<Custom13>string</Custom13>
<Custom14>string</Custom14>
<Custom15>string</Custom15>
<Custom16>string</Custom16>
<Custom17>string</Custom17>
<Custom18>string</Custom18>
<Custom19>string</Custom19>
<Custom2>string</Custom2>
<Custom20>string</Custom20>
<Custom3>string</Custom3>
<Custom4>string</Custom4>
<Custom5>string</Custom5>
<Custom6>string</Custom6>
<Custom7>string</Custom7>
<Custom8>string</Custom8>
<Custom9>string</Custom9>
<Name>string</Name>
<OrgUnit1>string</OrgUnit1>
<OrgUnit2>string</OrgUnit2>
<OrgUnit3>string</OrgUnit3>
<OrgUnit4>string</OrgUnit4>
<OrgUnit5>string</OrgUnit5>
<OrgUnit6>string</OrgUnit6>
<PolicyID>string</PolicyID>
<Purpose>string</Purpose>
<UserDefinedDate>2019-08-24T14:15:22Z</UserDefinedDate>
</ReportPost>
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| user | query | string | false | Optional. The login ID for the Report Owner. |
| body | body | ReportPost | true | Report object to create |
Example responses
200 Response
{
"ID": "string",
"URI": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CreateResponse>
<ID>string</ID>
<URI>string</URI>
</CreateResponse>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | CreateResponse |
| 400 | Bad Request | Bad Request | Void |
get_expense_reports{id}
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/expense/reports/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://www.concursolutions.com/api/v3.0/expense/reports/{id} HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/reports/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/expense/reports/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/expense/reports/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/expense/reports/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/reports/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/expense/reports/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /expense/reports/{id}
Gets a single report
Returns the specified report.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Report ID |
| user | query | string | false | Optional. The login ID of the report owner(s) to use when searching for reports. If the value is set to LoginID, reports for the report owner with this login ID value are returned. If the value is set to ALL, reports for all report owners are returned. If this parameter is not specified, reports for the OAuth Consumer are returned. The access token owner (OAuth Consumer) must have the Web Services Admin role to use this parameter. |
Example responses
200 Response
{
"AmountDueCompanyCard": 0,
"AmountDueEmployee": 0,
"ApprovalStatusCode": "string",
"ApprovalStatusName": "string",
"ApproverLoginID": "string",
"ApproverName": "string",
"Country": "string",
"CountrySubdivision": "string",
"CreateDate": "2019-08-24T14:15:22Z",
"CurrencyCode": "string",
"Custom1": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom2": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom3": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom4": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom5": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom6": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom7": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom8": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom9": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom10": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom11": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom12": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom13": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom14": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom15": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom16": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom17": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom18": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom19": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom20": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"EverSentBack": true,
"HasException": true,
"ID": "string",
"LastComment": "string",
"LastModifiedDate": "2019-08-24T14:15:22Z",
"LedgerName": "string",
"Name": "string",
"OrgUnit1": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit2": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit3": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit4": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit5": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit6": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OwnerLoginID": "string",
"OwnerName": "string",
"PaidDate": "2019-08-24T14:15:22Z",
"PaymentStatusCode": "string",
"PaymentStatusName": "string",
"PersonalAmount": 0,
"PolicyID": "string",
"ProcessingPaymentDate": "2019-08-24T14:15:22Z",
"ReceiptsReceived": true,
"SubmitDate": "2019-08-24T14:15:22Z",
"Total": 0,
"TotalApprovedAmount": 0,
"TotalClaimedAmount": 0,
"URI": "string",
"UserDefinedDate": "2019-08-24T14:15:22Z",
"WorkflowActionUrl": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ReportGet>
<AmountDueCompanyCard>0</AmountDueCompanyCard>
<AmountDueEmployee>0</AmountDueEmployee>
<ApprovalStatusCode>string</ApprovalStatusCode>
<ApprovalStatusName>string</ApprovalStatusName>
<ApproverLoginID>string</ApproverLoginID>
<ApproverName>string</ApproverName>
<Country>string</Country>
<CountrySubdivision>string</CountrySubdivision>
<CreateDate>2019-08-24T14:15:22Z</CreateDate>
<CurrencyCode>string</CurrencyCode>
<Custom1>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom1>
<Custom2>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom2>
<Custom3>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom3>
<Custom4>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom4>
<Custom5>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom5>
<Custom6>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom6>
<Custom7>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom7>
<Custom8>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom8>
<Custom9>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom9>
<Custom10>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom10>
<Custom11>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom11>
<Custom12>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom12>
<Custom13>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom13>
<Custom14>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom14>
<Custom15>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom15>
<Custom16>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom16>
<Custom17>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom17>
<Custom18>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom18>
<Custom19>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom19>
<Custom20>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</Custom20>
<EverSentBack>true</EverSentBack>
<HasException>true</HasException>
<ID>string</ID>
<LastComment>string</LastComment>
<LastModifiedDate>2019-08-24T14:15:22Z</LastModifiedDate>
<LedgerName>string</LedgerName>
<Name>string</Name>
<OrgUnit1>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</OrgUnit1>
<OrgUnit2>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</OrgUnit2>
<OrgUnit3>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</OrgUnit3>
<OrgUnit4>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</OrgUnit4>
<OrgUnit5>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</OrgUnit5>
<OrgUnit6>
<Code>string</Code>
<ListItemID>string</ListItemID>
<Type>string</Type>
<Value>string</Value>
</OrgUnit6>
<OwnerLoginID>string</OwnerLoginID>
<OwnerName>string</OwnerName>
<PaidDate>2019-08-24T14:15:22Z</PaidDate>
<PaymentStatusCode>string</PaymentStatusCode>
<PaymentStatusName>string</PaymentStatusName>
<PersonalAmount>0</PersonalAmount>
<PolicyID>string</PolicyID>
<ProcessingPaymentDate>2019-08-24T14:15:22Z</ProcessingPaymentDate>
<ReceiptsReceived>true</ReceiptsReceived>
<SubmitDate>2019-08-24T14:15:22Z</SubmitDate>
<Total>0</Total>
<TotalApprovedAmount>0</TotalApprovedAmount>
<TotalClaimedAmount>0</TotalClaimedAmount>
<URI>string</URI>
<UserDefinedDate>2019-08-24T14:15:22Z</UserDefinedDate>
<WorkflowActionUrl>string</WorkflowActionUrl>
</ReportGet>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ReportGet |
put_expense_reports{id}
Code samples
# You can also use wget
curl -X PUT https://www.concursolutions.com/api/v3.0/expense/reports/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
PUT https://www.concursolutions.com/api/v3.0/expense/reports/{id} HTTP/1.1
Host: www.concursolutions.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"Comment": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Name": "string",
"OrgUnit1": "string",
"OrgUnit2": "string",
"OrgUnit3": "string",
"OrgUnit4": "string",
"OrgUnit5": "string",
"OrgUnit6": "string",
"PolicyID": "string",
"Purpose": "string",
"UserDefinedDate": "2019-08-24T14:15:22Z"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/expense/reports/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put 'https://www.concursolutions.com/api/v3.0/expense/reports/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('https://www.concursolutions.com/api/v3.0/expense/reports/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','https://www.concursolutions.com/api/v3.0/expense/reports/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/expense/reports/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://www.concursolutions.com/api/v3.0/expense/reports/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /expense/reports/{id}
Update report
Updates the report specified in the URL. Only the provided fields will be updated, missing fields will not be altered.
Body parameter
{
"Comment": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Name": "string",
"OrgUnit1": "string",
"OrgUnit2": "string",
"OrgUnit3": "string",
"OrgUnit4": "string",
"OrgUnit5": "string",
"OrgUnit6": "string",
"PolicyID": "string",
"Purpose": "string",
"UserDefinedDate": "2019-08-24T14:15:22Z"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ReportPut>
<Comment>string</Comment>
<Custom1>string</Custom1>
<Custom10>string</Custom10>
<Custom11>string</Custom11>
<Custom12>string</Custom12>
<Custom13>string</Custom13>
<Custom14>string</Custom14>
<Custom15>string</Custom15>
<Custom16>string</Custom16>
<Custom17>string</Custom17>
<Custom18>string</Custom18>
<Custom19>string</Custom19>
<Custom2>string</Custom2>
<Custom20>string</Custom20>
<Custom3>string</Custom3>
<Custom4>string</Custom4>
<Custom5>string</Custom5>
<Custom6>string</Custom6>
<Custom7>string</Custom7>
<Custom8>string</Custom8>
<Custom9>string</Custom9>
<Name>string</Name>
<OrgUnit1>string</OrgUnit1>
<OrgUnit2>string</OrgUnit2>
<OrgUnit3>string</OrgUnit3>
<OrgUnit4>string</OrgUnit4>
<OrgUnit5>string</OrgUnit5>
<OrgUnit6>string</OrgUnit6>
<PolicyID>string</PolicyID>
<Purpose>string</Purpose>
<UserDefinedDate>2019-08-24T14:15:22Z</UserDefinedDate>
</ReportPut>
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The unique identifier for the report. |
| user | query | string | false | Optional. The login ID for the Report Owner. |
| body | body | ReportPut | true | The report object to update |
Example responses
200 Response
{}
<?xml version="1.0" encoding="UTF-8" ?>
<Void/>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Void |
| 400 | Bad Request | Bad Request | Void |
Schemas
CreateResponse
{
"ID": "string",
"URI": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ID | string | false | none | none |
| URI | string | false | none | none |
CustomField
{
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Code | string | false | none | For list fields, this is the list item code. |
| ListItemID | string | false | none | For list fields, this is the list item ID. |
| Type | string | false | none | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text |
| Value | string | false | none | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters |
ReportCollection
{
"Items": {
"AmountDueCompanyCard": 0,
"AmountDueEmployee": 0,
"ApprovalStatusCode": "string",
"ApprovalStatusName": "string",
"ApproverLoginID": "string",
"ApproverName": "string",
"Country": "string",
"CountrySubdivision": "string",
"CreateDate": "2019-08-24T14:15:22Z",
"CurrencyCode": "string",
"Custom1": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom2": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom3": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom4": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom5": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom6": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom7": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom8": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom9": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom10": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom11": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom12": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom13": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom14": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom15": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom16": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom17": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom18": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom19": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom20": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"EverSentBack": true,
"HasException": true,
"ID": "string",
"LastComment": "string",
"LastModifiedDate": "2019-08-24T14:15:22Z",
"LedgerName": "string",
"Name": "string",
"OrgUnit1": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit2": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit3": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit4": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit5": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit6": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OwnerLoginID": "string",
"OwnerName": "string",
"PaidDate": "2019-08-24T14:15:22Z",
"PaymentStatusCode": "string",
"PaymentStatusName": "string",
"PersonalAmount": 0,
"PolicyID": "string",
"ProcessingPaymentDate": "2019-08-24T14:15:22Z",
"ReceiptsReceived": true,
"SubmitDate": "2019-08-24T14:15:22Z",
"Total": 0,
"TotalApprovedAmount": 0,
"TotalClaimedAmount": 0,
"URI": "string",
"UserDefinedDate": "2019-08-24T14:15:22Z",
"WorkflowActionUrl": "string"
},
"NextPage": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Items | ReportGet | false | none | none |
| NextPage | string | false | none | The URI of the next page of results, if any. |
ReportGet
{
"AmountDueCompanyCard": 0,
"AmountDueEmployee": 0,
"ApprovalStatusCode": "string",
"ApprovalStatusName": "string",
"ApproverLoginID": "string",
"ApproverName": "string",
"Country": "string",
"CountrySubdivision": "string",
"CreateDate": "2019-08-24T14:15:22Z",
"CurrencyCode": "string",
"Custom1": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom2": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom3": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom4": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom5": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom6": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom7": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom8": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom9": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom10": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom11": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom12": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom13": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom14": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom15": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom16": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom17": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom18": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom19": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"Custom20": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"EverSentBack": true,
"HasException": true,
"ID": "string",
"LastComment": "string",
"LastModifiedDate": "2019-08-24T14:15:22Z",
"LedgerName": "string",
"Name": "string",
"OrgUnit1": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit2": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit3": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit4": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit5": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OrgUnit6": {
"Code": "string",
"ListItemID": "string",
"Type": "string",
"Value": "string"
},
"OwnerLoginID": "string",
"OwnerName": "string",
"PaidDate": "2019-08-24T14:15:22Z",
"PaymentStatusCode": "string",
"PaymentStatusName": "string",
"PersonalAmount": 0,
"PolicyID": "string",
"ProcessingPaymentDate": "2019-08-24T14:15:22Z",
"ReceiptsReceived": true,
"SubmitDate": "2019-08-24T14:15:22Z",
"Total": 0,
"TotalApprovedAmount": 0,
"TotalClaimedAmount": 0,
"URI": "string",
"UserDefinedDate": "2019-08-24T14:15:22Z",
"WorkflowActionUrl": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| AmountDueCompanyCard | number(double) | false | none | The total amount due to the company card for the report. Maximum 23 characters. |
| AmountDueEmployee | number(double) | false | none | The total amount due to the employee for the report. Maximum 23 characters. |
| ApprovalStatusCode | string | false | none | The approval status code for the report. |
| ApprovalStatusName | string | false | none | The report's approval status, in the OAuth consumer's language. |
| ApproverLoginID | string | false | none | The Login ID of the report owner's expense approver. |
| ApproverName | string | false | none | The name of the report owner's expense approver. |
| Country | string | false | none | The report country. Maximum 2 characters. Format: The ISO 3166-1 alpha-2 country code. Example: United States is US. |
| CountrySubdivision | string | false | none | The report country subdivision. Format: ISO 3166-2:2007 country subdivision. |
| CreateDate | string(date-time) | false | none | The date the report was created. |
| CurrencyCode | string | false | none | The 3-letter ISO 4217 currency code for the expense report currency. Examples: USD - US dollars; BRL - Brazilian real; CAD - Canadian dollar; CHF - Swiss franc; EUR - Euro; GBO - Pound sterling; HKD - Hong Kong dollar; INR - Indian rupee; MXN - Mexican peso; NOK - Norwegian krone; SEK - Swedish krona. |
| Custom1 | CustomField | false | none | none |
| Custom2 | CustomField | false | none | none |
| Custom3 | CustomField | false | none | none |
| Custom4 | CustomField | false | none | none |
| Custom5 | CustomField | false | none | none |
| Custom6 | CustomField | false | none | none |
| Custom7 | CustomField | false | none | none |
| Custom8 | CustomField | false | none | none |
| Custom9 | CustomField | false | none | none |
| Custom10 | CustomField | false | none | none |
| Custom11 | CustomField | false | none | none |
| Custom12 | CustomField | false | none | none |
| Custom13 | CustomField | false | none | none |
| Custom14 | CustomField | false | none | none |
| Custom15 | CustomField | false | none | none |
| Custom16 | CustomField | false | none | none |
| Custom17 | CustomField | false | none | none |
| Custom18 | CustomField | false | none | none |
| Custom19 | CustomField | false | none | none |
| Custom20 | CustomField | false | none | none |
| EverSentBack | boolean | false | none | Whether the report has ever been sent back to the employee. Format: Y/N |
| HasException | boolean | false | none | Whether the report has exceptions. Format: Y/N |
| ID | string | false | none | The unique identifier of the resource. |
| LastComment | string | false | none | The text of the most recent comment on the report. |
| LastModifiedDate | string(date-time) | false | none | The date the report header was last modified. |
| LedgerName | string | false | none | The name of the expense report ledger. Maximum 20 characters. |
| Name | string | false | none | The name of the report. |
| OrgUnit1 | CustomField | false | none | none |
| OrgUnit2 | CustomField | false | none | none |
| OrgUnit3 | CustomField | false | none | none |
| OrgUnit4 | CustomField | false | none | none |
| OrgUnit5 | CustomField | false | none | none |
| OrgUnit6 | CustomField | false | none | none |
| OwnerLoginID | string | false | none | The Login ID of the user this report belongs to. |
| OwnerName | string | false | none | The name of the expense report owner. |
| PaidDate | string(date-time) | false | none | The date when all journal entries in the report were integrated with or extracted to the financial system. |
| PaymentStatusCode | string | false | none | The code for the payment status of the report. |
| PaymentStatusName | string | false | none | The report's payment status, in the OAuth consumer's language. |
| PersonalAmount | number(double) | false | none | The total amount of expenses marked as personal. Maximum 23 characters. |
| PolicyID | string | false | none | The unique identifier of the policy that applies to this report. Maximum 64 characters. |
| ProcessingPaymentDate | string(date-time) | false | none | The date that the report completed all approvals and was ready to be extracted for payment. |
| ReceiptsReceived | boolean | false | none | If Y, then this report has its receipt receipt confirmed by the Expense Processor. Format: Y/N |
| SubmitDate | string(date-time) | false | none | The date the report was submitted. |
| Total | number(double) | false | none | The total amount of the report. |
| TotalApprovedAmount | number(double) | false | none | The total amount of approved expenses in the report. Maximum 23 characters. |
| TotalClaimedAmount | number(double) | false | none | The total amount of all non-personal expenses in the report. Maximum 23 characters. |
| URI | string | false | none | The URI to the resource. |
| UserDefinedDate | string(date-time) | false | none | The date of the report assigned by the user. |
| WorkflowActionUrl | string | false | none | The URL to post a workflow action to the report using the "Post Report Workflow Action" function. |
ReportPost
{
"Comment": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Name": "string",
"OrgUnit1": "string",
"OrgUnit2": "string",
"OrgUnit3": "string",
"OrgUnit4": "string",
"OrgUnit5": "string",
"OrgUnit6": "string",
"PolicyID": "string",
"Purpose": "string",
"UserDefinedDate": "2019-08-24T14:15:22Z"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Comment | string | false | none | The report header comment. Maximum length: 500. |
| Custom1 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom10 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom11 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom12 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom13 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom14 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom15 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom16 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom17 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom18 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom19 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom2 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom20 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom3 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom4 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom5 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom6 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom7 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom8 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom9 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Name | string | false | none | The name of the report. |
| OrgUnit1 | string | false | none | The details from the Org Unit fields. These may not have data, depending on configuration. |
| OrgUnit2 | string | false | none | The details from the Org Unit fields. These may not have data, depending on configuration. |
| OrgUnit3 | string | false | none | The details from the Org Unit fields. These may not have data, depending on configuration. |
| OrgUnit4 | string | false | none | The details from the Org Unit fields. These may not have data, depending on configuration. |
| OrgUnit5 | string | false | none | The details from the Org Unit fields. These may not have data, depending on configuration. |
| OrgUnit6 | string | false | none | The details from the Org Unit fields. These may not have data, depending on configuration. |
| PolicyID | string | false | none | The unique identifier for the policy. This is the protected Policy Key |
| Purpose | string | false | none | The business purpose of the report. Maximum length: 500. |
| UserDefinedDate | string(date-time) | false | none | The date of the report assigned by the user. |
ReportPut
{
"Comment": "string",
"Custom1": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom2": "string",
"Custom20": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Name": "string",
"OrgUnit1": "string",
"OrgUnit2": "string",
"OrgUnit3": "string",
"OrgUnit4": "string",
"OrgUnit5": "string",
"OrgUnit6": "string",
"PolicyID": "string",
"Purpose": "string",
"UserDefinedDate": "2019-08-24T14:15:22Z"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Comment | string | false | none | The report header comment. Maximum length: 500. |
| Custom1 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom10 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom11 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom12 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom13 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom14 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom15 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom16 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom17 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom18 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom19 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom2 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom20 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom3 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom4 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom5 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom6 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom7 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom8 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Custom9 | string | false | none | The details from the Custom fields. These may not have data, depending on configuration. |
| Name | string | false | none | The name of the report. |
| OrgUnit1 | string | false | none | The details from the Org Unit fields. These may not have data, depending on configuration. |
| OrgUnit2 | string | false | none | The details from the Org Unit fields. These may not have data, depending on configuration. |
| OrgUnit3 | string | false | none | The details from the Org Unit fields. These may not have data, depending on configuration. |
| OrgUnit4 | string | false | none | The details from the Org Unit fields. These may not have data, depending on configuration. |
| OrgUnit5 | string | false | none | The details from the Org Unit fields. These may not have data, depending on configuration. |
| OrgUnit6 | string | false | none | The details from the Org Unit fields. These may not have data, depending on configuration. |
| PolicyID | string | false | none | The unique identifier for the policy. This is the protected Policy Key |
| Purpose | string | false | none | The business purpose of the report. Maximum length: 500. |
| UserDefinedDate | string(date-time) | false | none | The date of the report assigned by the user. |
Void
{}
Properties
None
Sales Tax Validation Request v3.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
An invoice is a bill of sale for goods or services. This API provides invoice information so that clients can calculate appropriate sales tax for invoice items. It also allows clients to update the invoice with the calculated sales tax.
Base URLs:
Resources
get__invoice_salestaxvalidationrequest
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/invoice/salestaxvalidationrequest \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://www.concursolutions.com/api/v3.0/invoice/salestaxvalidationrequest HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/invoice/salestaxvalidationrequest',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/invoice/salestaxvalidationrequest',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/invoice/salestaxvalidationrequest', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/invoice/salestaxvalidationrequest', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/invoice/salestaxvalidationrequest");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/invoice/salestaxvalidationrequest", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /invoice/salestaxvalidationrequest
Get invoices
Gets invoices for the purpose of calculating sales tax.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| offset | query | string | false | The starting point of the next set of results, after the limit specified in the limit field has been reached. |
| limit | query | integer(int32) | false | The number of invoices to retrieve. Maximum value: 1000 |
| modifiedafter | query | string | false | A parameter that can be used to limit the results to invoices modified after the specified date. |
Example responses
200 Response
{
"Items": {
"BillToAddress": {
"Address1": "string",
"Address2": "string",
"Address3": "string",
"City": "string",
"CountryCode": "string",
"ExternalID": "string",
"Name": "string",
"PostalCode": "string",
"State": "string",
"StateProvince": "string"
},
"CalculatedTaxAmount": "string",
"CalculatedTaxRate": "string",
"CountryCode": "string",
"CurrencyCode": "string",
"ID": "string",
"InvoiceAmount": "string",
"InvoiceDate": "string",
"LineItem": {
"CalculatedTaxAmount": "string",
"CalculatedTaxRate": "string",
"CommodityCode": "string",
"CountryCode": "string",
"CurrencyCode": "string",
"LineItemKey": "string",
"Quantity": "string",
"Total": "string",
"UnitPrice": "string",
"Vendor": {
"Address1": "string",
"Address2": "string",
"Address3": "string",
"City": "string",
"CountryCode": "string",
"PostalCode": "string",
"State": "string",
"VendorAddressName": "string",
"VendorName": "string"
}
},
"PurchaseOrderNumber": "string",
"RequestID": "string",
"ShippingAmount": "string",
"ShipToAddress": {
"Address1": "string",
"Address2": "string",
"Address3": "string",
"City": "string",
"CountryCode": "string",
"ExternalID": "string",
"Name": "string",
"PostalCode": "string",
"State": "string",
"StateProvince": "string"
},
"Status": "string",
"StatusCode": "string",
"Tax": "string",
"TaxReferenceID": "string",
"Title": "string",
"Total": "string",
"URI": "string",
"VendorInvoiceNumber": "string"
},
"NextPage": "string",
"TotalCount": 0
}
<?xml version="1.0" encoding="UTF-8" ?>
<InvoiceGetCollection>
<Items>
<BillToAddress>
<Address1>string</Address1>
<Address2>string</Address2>
<Address3>string</Address3>
<City>string</City>
<CountryCode>string</CountryCode>
<ExternalID>string</ExternalID>
<Name>string</Name>
<PostalCode>string</PostalCode>
<State>string</State>
<StateProvince>string</StateProvince>
</BillToAddress>
<CalculatedTaxAmount>string</CalculatedTaxAmount>
<CalculatedTaxRate>string</CalculatedTaxRate>
<CountryCode>string</CountryCode>
<CurrencyCode>string</CurrencyCode>
<ID>string</ID>
<InvoiceAmount>string</InvoiceAmount>
<InvoiceDate>string</InvoiceDate>
<LineItem>
<CalculatedTaxAmount>string</CalculatedTaxAmount>
<CalculatedTaxRate>string</CalculatedTaxRate>
<CommodityCode>string</CommodityCode>
<CountryCode>string</CountryCode>
<CurrencyCode>string</CurrencyCode>
<LineItemKey>string</LineItemKey>
<Quantity>string</Quantity>
<Total>string</Total>
<UnitPrice>string</UnitPrice>
<Vendor>
<Address1>string</Address1>
<Address2>string</Address2>
<Address3>string</Address3>
<City>string</City>
<CountryCode>string</CountryCode>
<PostalCode>string</PostalCode>
<State>string</State>
<VendorAddressName>string</VendorAddressName>
<VendorName>string</VendorName>
</Vendor>
</LineItem>
<PurchaseOrderNumber>string</PurchaseOrderNumber>
<RequestID>string</RequestID>
<ShippingAmount>string</ShippingAmount>
<ShipToAddress>
<Address1>string</Address1>
<Address2>string</Address2>
<Address3>string</Address3>
<City>string</City>
<CountryCode>string</CountryCode>
<ExternalID>string</ExternalID>
<Name>string</Name>
<PostalCode>string</PostalCode>
<State>string</State>
<StateProvince>string</StateProvince>
</ShipToAddress>
<Status>string</Status>
<StatusCode>string</StatusCode>
<Tax>string</Tax>
<TaxReferenceID>string</TaxReferenceID>
<Title>string</Title>
<Total>string</Total>
<URI>string</URI>
<VendorInvoiceNumber>string</VendorInvoiceNumber>
</Items>
<NextPage>string</NextPage>
<TotalCount>0</TotalCount>
</InvoiceGetCollection>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | InvoiceGetCollection |
put__invoice_salestaxvalidationrequest
Code samples
# You can also use wget
curl -X PUT https://www.concursolutions.com/api/v3.0/invoice/salestaxvalidationrequest \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
PUT https://www.concursolutions.com/api/v3.0/invoice/salestaxvalidationrequest HTTP/1.1
Host: www.concursolutions.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"CalculatedTaxAmount": "string",
"CalculatedTaxRate": "string",
"Comments": "string",
"ID": "string",
"LineItem": {
"CalculatedTaxAmount": "string",
"CalculatedTaxRate": "string",
"LineItemKey": "string"
},
"Status": "string",
"StatusCode": "string",
"TaxReferenceID": "string",
"URI": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/invoice/salestaxvalidationrequest',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put 'https://www.concursolutions.com/api/v3.0/invoice/salestaxvalidationrequest',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('https://www.concursolutions.com/api/v3.0/invoice/salestaxvalidationrequest', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','https://www.concursolutions.com/api/v3.0/invoice/salestaxvalidationrequest', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/invoice/salestaxvalidationrequest");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://www.concursolutions.com/api/v3.0/invoice/salestaxvalidationrequest", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /invoice/salestaxvalidationrequest
Update invoices with the calculated tax information
Updates the specified invoices with the calculated tax amount and tax rate.
Body parameter
{
"CalculatedTaxAmount": "string",
"CalculatedTaxRate": "string",
"Comments": "string",
"ID": "string",
"LineItem": {
"CalculatedTaxAmount": "string",
"CalculatedTaxRate": "string",
"LineItemKey": "string"
},
"Status": "string",
"StatusCode": "string",
"TaxReferenceID": "string",
"URI": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<Invoice>
<CalculatedTaxAmount>string</CalculatedTaxAmount>
<CalculatedTaxRate>string</CalculatedTaxRate>
<Comments>string</Comments>
<ID>string</ID>
<LineItem>
<CalculatedTaxAmount>string</CalculatedTaxAmount>
<CalculatedTaxRate>string</CalculatedTaxRate>
<LineItemKey>string</LineItemKey>
</LineItem>
<Status>string</Status>
<StatusCode>string</StatusCode>
<TaxReferenceID>string</TaxReferenceID>
<URI>string</URI>
</Invoice>
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | Invoice | true | The tax information for the invoice that is to be updated. |
Example responses
200 Response
{
"Code": 0,
"Comments": "string",
"Message": "string",
"RecordNumber": 0,
"Status": "string",
"TaxReferenceID": "string",
"Type": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<InvoiceStatus>
<Code>0</Code>
<Comments>string</Comments>
<Message>string</Message>
<RecordNumber>0</RecordNumber>
<Status>string</Status>
<TaxReferenceID>string</TaxReferenceID>
<Type>string</Type>
</InvoiceStatus>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | InvoiceStatus |
| 400 | Bad Request | Bad Request | Void |
Schemas
BillToAddress
{
"Address1": "string",
"Address2": "string",
"Address3": "string",
"City": "string",
"CountryCode": "string",
"ExternalID": "string",
"Name": "string",
"PostalCode": "string",
"State": "string",
"StateProvince": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Address1 | string | false | none | Address line 1 of the shipping or billing address. |
| Address2 | string | false | none | Address line 2 of the shipping or billing address. |
| Address3 | string | false | none | Address line 3 of the shipping or billing address. |
| City | string | false | none | The city of the shipping or billing address. |
| CountryCode | string | false | none | The code of the country for the shipping or billing address. |
| ExternalID | string | false | none | A unique value supplied by the customer to identify a particular shipping or billing address. |
| Name | string | false | none | An optional name that can be given to the shipping or billing address. |
| PostalCode | string | false | none | The postal code of the shipping or billing address. |
| State | string | false | none | The state or province of the shipping or billing address. |
| StateProvince | string | false | none | The state or province of the shipping or billing address. |
Invoice
{
"CalculatedTaxAmount": "string",
"CalculatedTaxRate": "string",
"Comments": "string",
"ID": "string",
"LineItem": {
"CalculatedTaxAmount": "string",
"CalculatedTaxRate": "string",
"LineItemKey": "string"
},
"Status": "string",
"StatusCode": "string",
"TaxReferenceID": "string",
"URI": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| CalculatedTaxAmount | string | false | none | The calculated tax amount for the invoice. |
| CalculatedTaxRate | string | false | none | The calculated tax rate for the invoice. |
| Comments | string | false | none | Comments for the invoice. |
| ID | string | false | none | The unique identifier of the resource. |
| LineItem | InvoiceLineItemPut | false | none | none |
| Status | string | false | none | The status of the invoice. |
| StatusCode | string | false | none | The status code that indicates the outcome of tax validation. Supported values: ERROR, CMPLT |
| TaxReferenceID | string | false | none | The tax reference ID of the invoice. |
| URI | string | false | none | The URI to the resource. |
InvoiceGet
{
"BillToAddress": {
"Address1": "string",
"Address2": "string",
"Address3": "string",
"City": "string",
"CountryCode": "string",
"ExternalID": "string",
"Name": "string",
"PostalCode": "string",
"State": "string",
"StateProvince": "string"
},
"CalculatedTaxAmount": "string",
"CalculatedTaxRate": "string",
"CountryCode": "string",
"CurrencyCode": "string",
"ID": "string",
"InvoiceAmount": "string",
"InvoiceDate": "string",
"LineItem": {
"CalculatedTaxAmount": "string",
"CalculatedTaxRate": "string",
"CommodityCode": "string",
"CountryCode": "string",
"CurrencyCode": "string",
"LineItemKey": "string",
"Quantity": "string",
"Total": "string",
"UnitPrice": "string",
"Vendor": {
"Address1": "string",
"Address2": "string",
"Address3": "string",
"City": "string",
"CountryCode": "string",
"PostalCode": "string",
"State": "string",
"VendorAddressName": "string",
"VendorName": "string"
}
},
"PurchaseOrderNumber": "string",
"RequestID": "string",
"ShippingAmount": "string",
"ShipToAddress": {
"Address1": "string",
"Address2": "string",
"Address3": "string",
"City": "string",
"CountryCode": "string",
"ExternalID": "string",
"Name": "string",
"PostalCode": "string",
"State": "string",
"StateProvince": "string"
},
"Status": "string",
"StatusCode": "string",
"Tax": "string",
"TaxReferenceID": "string",
"Title": "string",
"Total": "string",
"URI": "string",
"VendorInvoiceNumber": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| BillToAddress | BillToAddress | false | none | none |
| CalculatedTaxAmount | string | false | none | The calculated tax amount for the invoice. |
| CalculatedTaxRate | string | false | none | The calculated tax rate for the invoice. |
| CountryCode | string | false | none | The country code for the line item. |
| CurrencyCode | string | false | none | The 3-letter ISO 4217 currency code for the invoice currency. For example, USD or CAD. |
| ID | string | false | none | The unique identifier of the resource. |
| InvoiceAmount | string | false | none | The invoice amount (the cost of the purchased items). |
| InvoiceDate | string | false | none | The invoice date. |
| LineItem | InvoiceLineItem | false | none | none |
| PurchaseOrderNumber | string | false | none | The purchase order number for the purchase order associated with the invoice. |
| RequestID | string | false | none | The request ID of the payment request |
| ShippingAmount | string | false | none | The shipping amount for the invoice. |
| ShipToAddress | ShipToAddress | false | none | none |
| Status | string | false | none | The status of the invoice. |
| StatusCode | string | false | none | The status code that indicates the outcome of tax validation. Supported values: ERROR, CMPLT |
| Tax | string | false | none | The tax as shown on the invoice. This is the tax applied by the vendor. |
| TaxReferenceID | string | false | none | The tax reference ID of the invoice. |
| Title | string | false | none | The title of the invoice. |
| Total | string | false | none | The total amount of the request. |
| URI | string | false | none | The URI to the resource. |
| VendorInvoiceNumber | string | false | none | The vendor invoice number that is associated with the invoice. |
InvoiceGetCollection
{
"Items": {
"BillToAddress": {
"Address1": "string",
"Address2": "string",
"Address3": "string",
"City": "string",
"CountryCode": "string",
"ExternalID": "string",
"Name": "string",
"PostalCode": "string",
"State": "string",
"StateProvince": "string"
},
"CalculatedTaxAmount": "string",
"CalculatedTaxRate": "string",
"CountryCode": "string",
"CurrencyCode": "string",
"ID": "string",
"InvoiceAmount": "string",
"InvoiceDate": "string",
"LineItem": {
"CalculatedTaxAmount": "string",
"CalculatedTaxRate": "string",
"CommodityCode": "string",
"CountryCode": "string",
"CurrencyCode": "string",
"LineItemKey": "string",
"Quantity": "string",
"Total": "string",
"UnitPrice": "string",
"Vendor": {
"Address1": "string",
"Address2": "string",
"Address3": "string",
"City": "string",
"CountryCode": "string",
"PostalCode": "string",
"State": "string",
"VendorAddressName": "string",
"VendorName": "string"
}
},
"PurchaseOrderNumber": "string",
"RequestID": "string",
"ShippingAmount": "string",
"ShipToAddress": {
"Address1": "string",
"Address2": "string",
"Address3": "string",
"City": "string",
"CountryCode": "string",
"ExternalID": "string",
"Name": "string",
"PostalCode": "string",
"State": "string",
"StateProvince": "string"
},
"Status": "string",
"StatusCode": "string",
"Tax": "string",
"TaxReferenceID": "string",
"Title": "string",
"Total": "string",
"URI": "string",
"VendorInvoiceNumber": "string"
},
"NextPage": "string",
"TotalCount": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Items | InvoiceGet | false | none | none |
| NextPage | string | false | none | The URI of the next page of results, if any. |
| TotalCount | integer(int32) | false | none | none |
InvoiceLineItem
{
"CalculatedTaxAmount": "string",
"CalculatedTaxRate": "string",
"CommodityCode": "string",
"CountryCode": "string",
"CurrencyCode": "string",
"LineItemKey": "string",
"Quantity": "string",
"Total": "string",
"UnitPrice": "string",
"Vendor": {
"Address1": "string",
"Address2": "string",
"Address3": "string",
"City": "string",
"CountryCode": "string",
"PostalCode": "string",
"State": "string",
"VendorAddressName": "string",
"VendorName": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| CalculatedTaxAmount | string | false | none | The calculated tax amount for the individual line item. |
| CalculatedTaxRate | string | false | none | The calculated tax rate for the individual line item. |
| CommodityCode | string | false | none | The commodity code that is tied to the expense type associated with the line item. |
| CountryCode | string | false | none | The country code for the line item. |
| CurrencyCode | string | false | none | The currency code for the individual line item. |
| LineItemKey | string | false | none | A value that uniquely identifies the line item. |
| Quantity | string | false | none | The quantity for the line item. |
| Total | string | false | none | The total amount for the line item. |
| UnitPrice | string | false | none | The unit price for the line item. |
| Vendor | InvoiceVendor | false | none | none |
InvoiceLineItemPut
{
"CalculatedTaxAmount": "string",
"CalculatedTaxRate": "string",
"LineItemKey": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| CalculatedTaxAmount | string | false | none | The calculated tax amount for the individual line item. |
| CalculatedTaxRate | string | false | none | The calculated tax rate for the individual line item. |
| LineItemKey | string | false | none | A value that uniquely identifies the line item. |
InvoiceStatus
{
"Code": 0,
"Comments": "string",
"Message": "string",
"RecordNumber": 0,
"Status": "string",
"TaxReferenceID": "string",
"Type": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Code | integer(int32) | false | none | Code of request result |
| Comments | string | false | none | Comments that are returned for the update request. |
| Message | string | false | none | Message of request result |
| RecordNumber | integer(int32) | false | none | Record Number for create/update request. |
| Status | string | false | none | The status of the update. Supported values: SUCCESS, FAILURE |
| TaxReferenceID | string | false | none | The tax reference ID of the updated invoice. |
| Type | string | false | none | Type request result |
InvoiceVendor
{
"Address1": "string",
"Address2": "string",
"Address3": "string",
"City": "string",
"CountryCode": "string",
"PostalCode": "string",
"State": "string",
"VendorAddressName": "string",
"VendorName": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Address1 | string | false | none | The Vendor Address 1. |
| Address2 | string | false | none | The Vendor Address 2. |
| Address3 | string | false | none | The Vendor Address 3. |
| City | string | false | none | The Vendor City. |
| CountryCode | string | false | none | The Vendor Country Code. |
| PostalCode | string | false | none | The Vendor Postal Code / Zip. |
| State | string | false | none | The Vendor State. |
| VendorAddressName | string | false | none | Name for Vendor Address. |
| VendorName | string | false | none | The name of the vendor. |
ShipToAddress
{
"Address1": "string",
"Address2": "string",
"Address3": "string",
"City": "string",
"CountryCode": "string",
"ExternalID": "string",
"Name": "string",
"PostalCode": "string",
"State": "string",
"StateProvince": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Address1 | string | false | none | Address line 1 of the shipping or billing address. |
| Address2 | string | false | none | Address line 2 of the shipping or billing address. |
| Address3 | string | false | none | Address line 3 of the shipping or billing address. |
| City | string | false | none | The city of the shipping or billing address. |
| CountryCode | string | false | none | The code of the country for the shipping or billing address. |
| ExternalID | string | false | none | A unique value supplied by the customer to identify a particular shipping or billing address. |
| Name | string | false | none | An optional name that can be given to the shipping or billing address. |
| PostalCode | string | false | none | The postal code of the shipping or billing address. |
| State | string | false | none | The state or province of the shipping or billing address. |
| StateProvince | string | false | none | The state or province of the shipping or billing address. |
Void
{}
Properties
None
Suppliers v3.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
TripLink supplier information.
Base URLs:
Resources
get__common_suppliers
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/common/suppliers \
-H 'Accept: application/json'
GET https://www.concursolutions.com/api/v3.0/common/suppliers HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://www.concursolutions.com/api/v3.0/common/suppliers',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/common/suppliers',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/common/suppliers', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/common/suppliers', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/common/suppliers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/common/suppliers", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /common/suppliers
Gets All Suppliers by Search Criteria
Returns all Suppliers based on the search criteria.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| name | query | string | false | Name |
| address | query | string | false | Address |
| address2 | query | string | false | Address |
| city | query | string | false | City |
| state | query | string | false | State |
| zip | query | string | false | Zip |
| country | query | string | false | Country Code |
| phone | query | string | false | Phone |
| mcCode | query | string | false | MCC Code (Ex: Delta Airline - 3058) |
| taxId | query | string | false | Tax Id |
| merchantType | query | string | false | Merchant Type Code(Ex: Visa - VI, Amex - AX) |
| merchantID | query | string | false | Merchant Id |
| iataCode | query | string | false | IATA Code |
| relevance | query | integer(int32) | false | Relevance of the Search results |
Example responses
200 Response
{
"Items": {
"BusinessName": "string",
"City": "string",
"CountryCode": "string",
"ID": "string",
"PostalCode": "string",
"State": "string",
"StreetAddress": "string",
"StreetAddress2": "string",
"URI": "string"
},
"NextPage": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<SupplierCollection>
<Items>
<BusinessName>string</BusinessName>
<City>string</City>
<CountryCode>string</CountryCode>
<ID>string</ID>
<PostalCode>string</PostalCode>
<State>string</State>
<StreetAddress>string</StreetAddress>
<StreetAddress2>string</StreetAddress2>
<URI>string</URI>
</Items>
<NextPage>string</NextPage>
</SupplierCollection>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SupplierCollection |
get_common_suppliers{id}
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/common/suppliers/{id} \
-H 'Accept: application/json'
GET https://www.concursolutions.com/api/v3.0/common/suppliers/{id} HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://www.concursolutions.com/api/v3.0/common/suppliers/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/common/suppliers/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/common/suppliers/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/common/suppliers/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/common/suppliers/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/common/suppliers/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /common/suppliers/{id}
Get a single Supplier by ID
Returns a single Supplier ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Supplier Id |
Example responses
200 Response
{
"AmadeusId": "string",
"AustinTetra": "string",
"BusinessName": "string",
"ChainCode": "string",
"ChainName": "string",
"City": "string",
"CountryCode": "string",
"CreditCardVendorId": "string",
"DunsNumber": "string",
"Email": "string",
"Fax": "string",
"GalileoId": "string",
"ID": "string",
"MccCode": "string",
"NorthstarId": "string",
"PegasusId": "string",
"Phone": "string",
"PostalCode": "string",
"PrimaryNaics": "string",
"PrimarySic": "string",
"PropertyCode": "string",
"SabreId": "string",
"SecondaryNaics": "string",
"SecondarySic": "string",
"State": "string",
"StreetAddress": "string",
"StreetAddress2": "string",
"TaxId": "string",
"TollFree": "string",
"URI": "string",
"WebUrl": "string",
"WorldspanId": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<SupplierSingle>
<AmadeusId>string</AmadeusId>
<AustinTetra>string</AustinTetra>
<BusinessName>string</BusinessName>
<ChainCode>string</ChainCode>
<ChainName>string</ChainName>
<City>string</City>
<CountryCode>string</CountryCode>
<CreditCardVendorId>string</CreditCardVendorId>
<DunsNumber>string</DunsNumber>
<Email>string</Email>
<Fax>string</Fax>
<GalileoId>string</GalileoId>
<ID>string</ID>
<MccCode>string</MccCode>
<NorthstarId>string</NorthstarId>
<PegasusId>string</PegasusId>
<Phone>string</Phone>
<PostalCode>string</PostalCode>
<PrimaryNaics>string</PrimaryNaics>
<PrimarySic>string</PrimarySic>
<PropertyCode>string</PropertyCode>
<SabreId>string</SabreId>
<SecondaryNaics>string</SecondaryNaics>
<SecondarySic>string</SecondarySic>
<State>string</State>
<StreetAddress>string</StreetAddress>
<StreetAddress2>string</StreetAddress2>
<TaxId>string</TaxId>
<TollFree>string</TollFree>
<URI>string</URI>
<WebUrl>string</WebUrl>
<WorldspanId>string</WorldspanId>
</SupplierSingle>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SupplierSingle |
Schemas
SupplierCollection
{
"Items": {
"BusinessName": "string",
"City": "string",
"CountryCode": "string",
"ID": "string",
"PostalCode": "string",
"State": "string",
"StreetAddress": "string",
"StreetAddress2": "string",
"URI": "string"
},
"NextPage": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Items | SupplierGet | false | none | none |
| NextPage | string | false | none | The URI of the next page of results, if any. |
SupplierGet
{
"BusinessName": "string",
"City": "string",
"CountryCode": "string",
"ID": "string",
"PostalCode": "string",
"State": "string",
"StreetAddress": "string",
"StreetAddress2": "string",
"URI": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| BusinessName | string | false | none | Name |
| City | string | false | none | City |
| CountryCode | string | false | none | Country Code |
| ID | string | false | none | The unique identifier of the resource. |
| PostalCode | string | false | none | Zip |
| State | string | false | none | State |
| StreetAddress | string | false | none | Address |
| StreetAddress2 | string | false | none | Address2 |
| URI | string | false | none | The URI to the resource. |
SupplierSingle
{
"AmadeusId": "string",
"AustinTetra": "string",
"BusinessName": "string",
"ChainCode": "string",
"ChainName": "string",
"City": "string",
"CountryCode": "string",
"CreditCardVendorId": "string",
"DunsNumber": "string",
"Email": "string",
"Fax": "string",
"GalileoId": "string",
"ID": "string",
"MccCode": "string",
"NorthstarId": "string",
"PegasusId": "string",
"Phone": "string",
"PostalCode": "string",
"PrimaryNaics": "string",
"PrimarySic": "string",
"PropertyCode": "string",
"SabreId": "string",
"SecondaryNaics": "string",
"SecondarySic": "string",
"State": "string",
"StreetAddress": "string",
"StreetAddress2": "string",
"TaxId": "string",
"TollFree": "string",
"URI": "string",
"WebUrl": "string",
"WorldspanId": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| AmadeusId | string | false | none | Amadeus Id |
| AustinTetra | string | false | none | Austin Tetra |
| BusinessName | string | false | none | Name |
| ChainCode | string | false | none | Chain Code |
| ChainName | string | false | none | Chain Name |
| City | string | false | none | City |
| CountryCode | string | false | none | Country Code |
| CreditCardVendorId | string | false | none | Creditcard Vendor Id |
| DunsNumber | string | false | none | Duns Number |
| string | false | none | ||
| Fax | string | false | none | Fax |
| GalileoId | string | false | none | Galileo Id |
| ID | string | false | none | The unique identifier of the resource. |
| MccCode | string | false | none | MCC Code (Ex: Delta Airline - 3058) |
| NorthstarId | string | false | none | Northstar Id |
| PegasusId | string | false | none | Pegasus Id |
| Phone | string | false | none | Phone |
| PostalCode | string | false | none | Zip |
| PrimaryNaics | string | false | none | Primary Naics Code |
| PrimarySic | string | false | none | Primary Sic Code |
| PropertyCode | string | false | none | undefined:ConnectSwaggerDocs-SUP_PARAM_PROPERTY_CODE |
| SabreId | string | false | none | Sabre Id |
| SecondaryNaics | string | false | none | Secondary Naics Code |
| SecondarySic | string | false | none | Secondary Sic Code |
| State | string | false | none | State |
| StreetAddress | string | false | none | Address |
| StreetAddress2 | string | false | none | Address2 |
| TaxId | string | false | none | Tax Id |
| TollFree | string | false | none | Toll Free |
| URI | string | false | none | The URI to the resource. |
| WebUrl | string | false | none | Web Address |
| WorldspanId | string | false | none | Worldspan Id |
Users v3.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Provides details of all the client's SAP Concur users that meet the search parameters.
Base URLs:
Resources
get__common_users
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/common/users \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://www.concursolutions.com/api/v3.0/common/users HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://www.concursolutions.com/api/v3.0/common/users',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/common/users',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/common/users', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/common/users', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/common/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/common/users", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /common/users
Get all users.
Retrieves all users based on the search criteria.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| offset | query | string | false | The starting point of the next set of results, after the limit specified in the limit field has been reached. |
| limit | query | integer(int32) | false | The number of records to return. Default value: 25. Maximum: 100. |
| primaryEmail | query | string | false | The primary email of the user. |
| employeeID | query | string | false | The employee ID of the user. |
| user | query | string | false | The login ID of the user. |
| lastName | query | string | false | The last name of the user. |
| active | query | boolean | false | Indicates whether to return active or inactive users. FORMAT: true or false |
Example responses
200 Response
{
"Items": {
"Active": true,
"CellPhoneNumber": "string",
"EmployeeID": "string",
"FirstName": "string",
"ID": "string",
"LastName": "string",
"LoginID": "string",
"MiddleName": "string",
"OrganizationUnit": "string",
"PrimaryEmail": "string",
"URI": "string"
},
"NextPage": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<UserCollection>
<Items>
<Active>true</Active>
<CellPhoneNumber>string</CellPhoneNumber>
<EmployeeID>string</EmployeeID>
<FirstName>string</FirstName>
<ID>string</ID>
<LastName>string</LastName>
<LoginID>string</LoginID>
<MiddleName>string</MiddleName>
<OrganizationUnit>string</OrganizationUnit>
<PrimaryEmail>string</PrimaryEmail>
<URI>string</URI>
</Items>
<NextPage>string</NextPage>
</UserCollection>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | UserCollection |
Schemas
User
{
"Active": true,
"CellPhoneNumber": "string",
"EmployeeID": "string",
"FirstName": "string",
"ID": "string",
"LastName": "string",
"LoginID": "string",
"MiddleName": "string",
"OrganizationUnit": "string",
"PrimaryEmail": "string",
"URI": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Active | boolean | false | none | Indicates whether the user is currently active or not. |
| CellPhoneNumber | string | false | none | The cell phone number of the user. |
| EmployeeID | string | false | none | The employee ID of the user. |
| FirstName | string | false | none | The first name of the user. |
| ID | string | false | none | The unique identifier of the resource. |
| LastName | string | false | none | The last name of the user. |
| LoginID | string | false | none | The login ID of the user. |
| MiddleName | string | false | none | The middle name of the user. |
| OrganizationUnit | string | false | none | The organization unit of the user. |
| PrimaryEmail | string | false | none | The primary email of the user. |
| URI | string | false | none | The URI to the resource. |
UserCollection
{
"Items": {
"Active": true,
"CellPhoneNumber": "string",
"EmployeeID": "string",
"FirstName": "string",
"ID": "string",
"LastName": "string",
"LoginID": "string",
"MiddleName": "string",
"OrganizationUnit": "string",
"PrimaryEmail": "string",
"URI": "string"
},
"NextPage": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Items | User | false | none | none |
| NextPage | string | false | none | The URI of the next page of results, if any. |
title: VendorBank v3.0 language_tabs: - shell: Shell - http: HTTP - javascript: JavaScript - ruby: Ruby - python: Python - php: PHP - java: Java - go: Go toc_footers: [] includes: [] search: true highlight_theme: darkula headingLevel: 2 generator: widdershins v4.0.1
VendorBank v3.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
An invoice is a bill of sale for goods or services provided by a vendor. This API provides methods to create or update banking information for the specified invoice vendor.
Base URLs:
Resources
put__invoice_vendor_banks
Code samples
# You can also use wget
curl -X PUT https://www.concursolutions.com/api/v3.0/invoice/vendor/banks \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
PUT https://www.concursolutions.com/api/v3.0/invoice/vendor/banks HTTP/1.1
Host: www.concursolutions.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"VendorBank": {
"AccountNumber": "string",
"AccountType": "string",
"AddressCode": "string",
"BankCode": "string",
"BankName": "string",
"BranchCode": "string",
"BranchLocation": "string",
"CountryCode": "string",
"CurrencyAlphaCode": "string",
"ID": "string",
"IsActive": "string",
"NameOnAccount": "string",
"RoutingNumber": "string",
"StatusList": {
"Code": 0,
"Message": "string",
"RecordNumber": 0,
"Type": "string"
},
"TransType": "string",
"URI": "string",
"VendorCode": "string"
},
"NextPage": "string",
"RequestRunSummary": "string",
"TotalCount": 0,
"Items": null
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://www.concursolutions.com/api/v3.0/invoice/vendor/banks',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.put 'https://www.concursolutions.com/api/v3.0/invoice/vendor/banks',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.put('https://www.concursolutions.com/api/v3.0/invoice/vendor/banks', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','https://www.concursolutions.com/api/v3.0/invoice/vendor/banks', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/invoice/vendor/banks");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://www.concursolutions.com/api/v3.0/invoice/vendor/banks", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /invoice/vendor/banks
Updates/creates vendor banking information.
Updates/creates vendor banking information.
Body parameter
{
"VendorBank": {
"AccountNumber": "string",
"AccountType": "string",
"AddressCode": "string",
"BankCode": "string",
"BankName": "string",
"BranchCode": "string",
"BranchLocation": "string",
"CountryCode": "string",
"CurrencyAlphaCode": "string",
"ID": "string",
"IsActive": "string",
"NameOnAccount": "string",
"RoutingNumber": "string",
"StatusList": {
"Code": 0,
"Message": "string",
"RecordNumber": 0,
"Type": "string"
},
"TransType": "string",
"URI": "string",
"VendorCode": "string"
},
"NextPage": "string",
"RequestRunSummary": "string",
"TotalCount": 0,
"Items": null
}
<?xml version="1.0" encoding="UTF-8" ?>
<VendorBankCollection>
<VendorBank>
<AccountNumber>string</AccountNumber>
<AccountType>string</AccountType>
<AddressCode>string</AddressCode>
<BankCode>string</BankCode>
<BankName>string</BankName>
<BranchCode>string</BranchCode>
<BranchLocation>string</BranchLocation>
<CountryCode>string</CountryCode>
<CurrencyAlphaCode>string</CurrencyAlphaCode>
<ID>string</ID>
<IsActive>string</IsActive>
<NameOnAccount>string</NameOnAccount>
<RoutingNumber>string</RoutingNumber>
<StatusList>
<Code>0</Code>
<Message>string</Message>
<RecordNumber>0</RecordNumber>
<Type>string</Type>
</StatusList>
<TransType>string</TransType>
<URI>string</URI>
<VendorCode>string</VendorCode>
</VendorBank>
<NextPage>string</NextPage>
<RequestRunSummary>string</RequestRunSummary>
<TotalCount>0</TotalCount>
<Items/>
</VendorBankCollection>
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | VendorBankCollection | true | The vendor bank details. |
Example responses
200 Response
{
"VendorBank": {
"AccountNumber": "string",
"AccountType": "string",
"AddressCode": "string",
"BankCode": "string",
"BankName": "string",
"BranchCode": "string",
"BranchLocation": "string",
"CountryCode": "string",
"CurrencyAlphaCode": "string",
"ID": "string",
"IsActive": "string",
"NameOnAccount": "string",
"RoutingNumber": "string",
"StatusList": {
"Code": 0,
"Message": "string",
"RecordNumber": 0,
"Type": "string"
},
"TransType": "string",
"URI": "string",
"VendorCode": "string"
},
"NextPage": "string",
"RequestRunSummary": "string",
"TotalCount": 0,
"Items": null
}
<?xml version="1.0" encoding="UTF-8" ?>
<VendorBankCollection>
<VendorBank>
<AccountNumber>string</AccountNumber>
<AccountType>string</AccountType>
<AddressCode>string</AddressCode>
<BankCode>string</BankCode>
<BankName>string</BankName>
<BranchCode>string</BranchCode>
<BranchLocation>string</BranchLocation>
<CountryCode>string</CountryCode>
<CurrencyAlphaCode>string</CurrencyAlphaCode>
<ID>string</ID>
<IsActive>string</IsActive>
<NameOnAccount>string</NameOnAccount>
<RoutingNumber>string</RoutingNumber>
<StatusList>
<Code>0</Code>
<Message>string</Message>
<RecordNumber>0</RecordNumber>
<Type>string</Type>
</StatusList>
<TransType>string</TransType>
<URI>string</URI>
<VendorCode>string</VendorCode>
</VendorBank>
<NextPage>string</NextPage>
<RequestRunSummary>string</RequestRunSummary>
<TotalCount>0</TotalCount>
<Items/>
</VendorBankCollection>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | VendorBankCollection |
Schemas
Status
{
"Code": 0,
"Message": "string",
"RecordNumber": 0,
"Type": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Code | integer(int32) | false | none | Code of request result |
| Message | string | false | none | Message of request result |
| RecordNumber | integer(int32) | false | none | Record Number for create/update request. |
| Type | string | false | none | Type request result |
VendorBank
{
"AccountNumber": "string",
"AccountType": "string",
"AddressCode": "string",
"BankCode": "string",
"BankName": "string",
"BranchCode": "string",
"BranchLocation": "string",
"CountryCode": "string",
"CurrencyAlphaCode": "string",
"ID": "string",
"IsActive": "string",
"NameOnAccount": "string",
"RoutingNumber": "string",
"StatusList": {
"Code": 0,
"Message": "string",
"RecordNumber": 0,
"Type": "string"
},
"TransType": "string",
"URI": "string",
"VendorCode": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| AccountNumber | string | false | none | The account number. |
| AccountType | string | false | none | The account type--CHCK for checking, SAVE for saving |
| AddressCode | string | false | none | The Vendor Address Code. |
| BankCode | string | false | none | Bank Code |
| BankName | string | false | none | The bank name. |
| BranchCode | string | false | none | Branch Code |
| BranchLocation | string | false | none | The branch location |
| CountryCode | string | false | none | The country code. |
| CurrencyAlphaCode | string | false | none | The currency alpha Code. |
| ID | string | false | none | The unique identifier of the resource. |
| IsActive | string | false | none | Is information active |
| NameOnAccount | string | false | none | The name on the account. |
| RoutingNumber | string | false | none | The routing number. |
| StatusList | Status | false | none | none |
| TransType | string | false | none | The trans type. |
| URI | string | false | none | The URI to the resource. |
| VendorCode | string | false | none | The vendor code of the request. |
VendorBankCollection
{
"VendorBank": {
"AccountNumber": "string",
"AccountType": "string",
"AddressCode": "string",
"BankCode": "string",
"BankName": "string",
"BranchCode": "string",
"BranchLocation": "string",
"CountryCode": "string",
"CurrencyAlphaCode": "string",
"ID": "string",
"IsActive": "string",
"NameOnAccount": "string",
"RoutingNumber": "string",
"StatusList": {
"Code": 0,
"Message": "string",
"RecordNumber": 0,
"Type": "string"
},
"TransType": "string",
"URI": "string",
"VendorCode": "string"
},
"NextPage": "string",
"RequestRunSummary": "string",
"TotalCount": 0,
"Items": null
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| VendorBank | VendorBank | false | none | none |
| NextPage | string | false | none | The URI of the next page of results, if any. |
| RequestRunSummary | string | false | none | The URI of the next page of results, if any. |
| TotalCount | integer(int32) | false | none | Record Number for create/update request. |
| Items | any | false | none | none |
title: VendorGroup v3.0 language_tabs: - shell: Shell - http: HTTP - javascript: JavaScript - ruby: Ruby - python: Python - php: PHP - java: Java - go: Go toc_footers: [] includes: [] search: true highlight_theme: darkula headingLevel: 2 generator: widdershins v4.0.1
VendorGroup v3.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
An invoice is a bill of sale for goods or services provided by a vendor. This API provides methods to create or delete invoice vendor groups that meet the search parameters.
Base URLs:
Resources
put__invoice_vendor_groups
Code samples
# You can also use wget
curl -X PUT https://www.concursolutions.com/api/v3.0/invoice/vendor/groups?vendorCode=string&addressCode=string \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
PUT https://www.concursolutions.com/api/v3.0/invoice/vendor/groups?vendorCode=string&addressCode=string HTTP/1.1
Host: www.concursolutions.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"VendorGroup": {
"ID": "string",
"Name": "string",
"URI": "string"
},
"NextPage": "string",
"RequestRunSummary": "string",
"TotalCount": 0,
"Items": null
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://www.concursolutions.com/api/v3.0/invoice/vendor/groups?vendorCode=string&addressCode=string',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.put 'https://www.concursolutions.com/api/v3.0/invoice/vendor/groups',
params: {
'vendorCode' => 'string',
'addressCode' => 'string'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.put('https://www.concursolutions.com/api/v3.0/invoice/vendor/groups', params={
'vendorCode': 'string', 'addressCode': 'string'
}, headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','https://www.concursolutions.com/api/v3.0/invoice/vendor/groups', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/invoice/vendor/groups?vendorCode=string&addressCode=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://www.concursolutions.com/api/v3.0/invoice/vendor/groups", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /invoice/vendor/groups
Add vendor groups by Vendor Code, Address Code, and Vendor Group.
Add vendor groups by Vendor Code, Address Code, and Vendor Group.
Body parameter
{
"VendorGroup": {
"ID": "string",
"Name": "string",
"URI": "string"
},
"NextPage": "string",
"RequestRunSummary": "string",
"TotalCount": 0,
"Items": null
}
<?xml version="1.0" encoding="UTF-8" ?>
<VendorGroupCollection>
<VendorGroup>
<ID>string</ID>
<Name>string</Name>
<URI>string</URI>
</VendorGroup>
<NextPage>string</NextPage>
<RequestRunSummary>string</RequestRunSummary>
<TotalCount>0</TotalCount>
<Items/>
</VendorGroupCollection>
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| vendorCode | query | string | true | The Vendor Code to be searched. |
| addressCode | query | string | true | Address Code to be searched. |
| body | body | VendorGroupCollection | true | The vendor group details. |
Example responses
200 Response
{
"VendorGroup": {
"ID": "string",
"Name": "string",
"URI": "string"
},
"NextPage": "string",
"RequestRunSummary": "string",
"TotalCount": 0,
"Items": null
}
<?xml version="1.0" encoding="UTF-8" ?>
<VendorGroupCollection>
<VendorGroup>
<ID>string</ID>
<Name>string</Name>
<URI>string</URI>
</VendorGroup>
<NextPage>string</NextPage>
<RequestRunSummary>string</RequestRunSummary>
<TotalCount>0</TotalCount>
<Items/>
</VendorGroupCollection>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | VendorGroupCollection |
delete__invoice_vendor_groups
Code samples
# You can also use wget
curl -X DELETE https://www.concursolutions.com/api/v3.0/invoice/vendor/groups?vendorCode=string&addressCode=string&groupName=string \
-H 'Accept: application/json'
DELETE https://www.concursolutions.com/api/v3.0/invoice/vendor/groups?vendorCode=string&addressCode=string&groupName=string HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://www.concursolutions.com/api/v3.0/invoice/vendor/groups?vendorCode=string&addressCode=string&groupName=string',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.delete 'https://www.concursolutions.com/api/v3.0/invoice/vendor/groups',
params: {
'vendorCode' => 'string',
'addressCode' => 'string',
'groupName' => 'string'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.delete('https://www.concursolutions.com/api/v3.0/invoice/vendor/groups', params={
'vendorCode': 'string', 'addressCode': 'string', 'groupName': 'string'
}, headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','https://www.concursolutions.com/api/v3.0/invoice/vendor/groups', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/invoice/vendor/groups?vendorCode=string&addressCode=string&groupName=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://www.concursolutions.com/api/v3.0/invoice/vendor/groups", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /invoice/vendor/groups
Delete a vendor group by Vendor Code, Address Code, and Group Name.
Delete a vendor group by Vendor Code, Address Code, and Group Name.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| vendorCode | query | string | true | The Vendor Code to be deleted. |
| addressCode | query | string | true | Address Code to be deleted. |
| groupName | query | string | true | Group Name to be deleted. |
Example responses
200 Response
{
"VendorGroup": {
"ID": "string",
"Name": "string",
"URI": "string"
},
"NextPage": "string",
"RequestRunSummary": "string",
"TotalCount": 0,
"Items": null
}
<?xml version="1.0" encoding="UTF-8" ?>
<VendorGroupCollection>
<VendorGroup>
<ID>string</ID>
<Name>string</Name>
<URI>string</URI>
</VendorGroup>
<NextPage>string</NextPage>
<RequestRunSummary>string</RequestRunSummary>
<TotalCount>0</TotalCount>
<Items/>
</VendorGroupCollection>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | VendorGroupCollection |
Schemas
Status
{
"Code": 0,
"Message": "string",
"RecordNumber": 0,
"Type": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Code | integer(int32) | false | none | Code of request result |
| Message | string | false | none | Message of request result |
| RecordNumber | integer(int32) | false | none | Record Number for create/update request. |
| Type | string | false | none | Type request result |
VendorGroup
{
"ID": "string",
"Name": "string",
"URI": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ID | string | false | none | The unique identifier of the resource. |
| Name | string | false | none | The group name |
| URI | string | false | none | The URI to the resource. |
VendorGroupCollection
{
"VendorGroup": {
"ID": "string",
"Name": "string",
"URI": "string"
},
"NextPage": "string",
"RequestRunSummary": "string",
"TotalCount": 0,
"Items": null
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| VendorGroup | VendorGroup | false | none | none |
| NextPage | string | false | none | The URI of the next page of results, if any. |
| RequestRunSummary | string | false | none | The URI of the next page of results, if any. |
| TotalCount | integer(int32) | false | none | Record Number for create/update request. |
| Items | any | false | none | none |
title: Vendors v3.0 language_tabs: - shell: Shell - http: HTTP - javascript: JavaScript - ruby: Ruby - python: Python - php: PHP - java: Java - go: Go toc_footers: [] includes: [] search: true highlight_theme: darkula headingLevel: 2 generator: widdershins v4.0.1
Vendors v3.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
An invoice is a bill of sale for goods or services provided by a vendor. This API provides methods to create, update, or delete invoice vendors.
Base URLs:
Resources
get__invoice_vendors
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.0/invoice/vendors \
-H 'Accept: application/json'
GET https://www.concursolutions.com/api/v3.0/invoice/vendors HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://www.concursolutions.com/api/v3.0/invoice/vendors',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.0/invoice/vendors',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://www.concursolutions.com/api/v3.0/invoice/vendors', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.0/invoice/vendors', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/invoice/vendors");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.0/invoice/vendors", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /invoice/vendors
Retrieves an existing vendor.
Gets an existing vendor. Note: If authenticating with a Company access token the API will return all vendors associated with a specific entity.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| limit | query | integer(int32) | false | The maximum number of items to be returned in a response. The default is 25 and cannot exceed 1000. |
| offset | query | string | false | Specifies the starting point for the next query when iterating through the collection response. Use with paged collections of resources. |
| sortDirection | query | string | false | ascending or descending, The default value will be ascending. |
| sortBy | query | string | false | Field you need to the results to be sorted by. Vendor Name will be made default if no value is sent. Only fields that are added to the vendor form can be used here. Fields have to be specified by name as specified in Doc. |
| searchType | query | string | false | Applies for the entire given search parameters. The default value is exact. Supported values: exact, begins, contains, ends |
| vendorCode | query | string | false | Vendor Code to be searched |
| vendorName | query | string | false | Vendor Name to be searched |
| taxID | query | string | false | Tax ID to be searched |
| buyerAccountNumber | query | string | false | Buyer Account Number to be searched |
| addressCode | query | string | false | Address Code to be searched |
| paymentMethodType | query | string | false | Payment Method Type to be searched. Valid values are ACH, CARD, CHECK, CLIENT, PAYPVD, VCHER, WIRE |
| address1 | query | string | false | Address 1 to be searched |
| address2 | query | string | false | Address 2 to be searched |
| address3 | query | string | false | Address 3 to be searched |
| city | query | string | false | City to be searched |
| state | query | string | false | State to be searched |
| postalCode | query | string | false | Postal Code to be searched |
| approved | query | string | false | Find Approved/Un Approved Vendors , True/False |
| country | query | string | false | Country to be searched |
| custom1 | query | string | false | Custom 1 to be searched |
| custom2 | query | string | false | Custom 2 to be searched |
| custom3 | query | string | false | Custom 3 to be searched |
| custom4 | query | string | false | Custom 4 to be searched |
| custom5 | query | string | false | Custom 5 to be searched |
| custom6 | query | string | false | Custom 6 to be searched |
| custom7 | query | string | false | Custom 7 to be searched |
| custom8 | query | string | false | Custom 8 to be searched |
| custom9 | query | string | false | Custom 9 to be searched |
| custom10 | query | string | false | Custom 10 to be searched |
| custom11 | query | string | false | Custom 11 to be searched |
| custom12 | query | string | false | Custom 12 to be searched |
| custom13 | query | string | false | Custom 13 to be searched |
| custom14 | query | string | false | Custom 14 to be searched |
| custom15 | query | string | false | Custom 15 to be searched |
| custom16 | query | string | false | Custom 16 to be searched |
| custom17 | query | string | false | Custom 17 to be searched |
| custom18 | query | string | false | Custom 18 to be searched |
| custom19 | query | string | false | Custom 19 to be searched |
| custom20 | query | string | false | Custom 20 to be searched |
Example responses
200 Response
{
"Vendor": {
"AccountNumber": "string",
"Address1": "string",
"Address2": "string",
"Address3": "string",
"AddressCode": "string",
"AddressImportSyncID": "string",
"Approved": "string",
"City": "string",
"ContactEmail": "string",
"ContactFirstName": "string",
"ContactLastName": "string",
"ContactPhoneNumber": "string",
"Country": "string",
"CountryCode": "string",
"CurrencyCode": "string",
"Custom1": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"DefaultEmployeeID": "string",
"DefaultExpenseTypeName": "string",
"DiscountPercentage": "string",
"DiscountTermsDays": "string",
"ID": "string",
"IsLineItemVatIncld": "string",
"IsVisibleForContentExtraction": "string",
"PaymentMethodType": "string",
"PaymentTerms": "string",
"PostalCode": "string",
"ProvincialTaxID": "string",
"PurchaseOrderContactEmail": "string",
"PurchaseOrderContactFirstName": "string",
"PurchaseOrderContactLastName": "string",
"PurchaseOrderContactPhoneNumber": "string",
"ShippingMethod": "string",
"ShippingTerms": "string",
"State": "string",
"StatusList": {
"Code": 0,
"Message": "string",
"RecordNumber": 0,
"Type": "string"
},
"TaxID": "string",
"TaxType": "string",
"URI": "string",
"VendorBankList": {
"AccountNumber": "string",
"AccountType": "string",
"AddressCode": "string",
"BankCode": "string",
"BankName": "string",
"BranchCode": "string",
"BranchLocation": "string",
"CountryCode": "string",
"CurrencyAlphaCode": "string",
"ID": "string",
"IsActive": "string",
"NameOnAccount": "string",
"RoutingNumber": "string",
"StatusList": {
"Code": 0,
"Message": "string",
"RecordNumber": 0,
"Type": "string"
},
"TransType": "string",
"URI": "string",
"VendorCode": "string"
},
"VendorCode": "string",
"VendorFormName": "string",
"VendorGroupList": [
"string"
],
"VendorName": "string",
"VoucherNotes": "string"
},
"NextPage": "string",
"RequestRunSummary": "string",
"TotalCount": 0,
"Items": null
}
<?xml version="1.0" encoding="UTF-8" ?>
<VendorCollection>
<Vendor>
<AccountNumber>string</AccountNumber>
<Address1>string</Address1>
<Address2>string</Address2>
<Address3>string</Address3>
<AddressCode>string</AddressCode>
<AddressImportSyncID>string</AddressImportSyncID>
<Approved>string</Approved>
<City>string</City>
<ContactEmail>string</ContactEmail>
<ContactFirstName>string</ContactFirstName>
<ContactLastName>string</ContactLastName>
<ContactPhoneNumber>string</ContactPhoneNumber>
<Country>string</Country>
<CountryCode>string</CountryCode>
<CurrencyCode>string</CurrencyCode>
<Custom1>string</Custom1>
<Custom2>string</Custom2>
<Custom3>string</Custom3>
<Custom4>string</Custom4>
<Custom5>string</Custom5>
<Custom6>string</Custom6>
<Custom7>string</Custom7>
<Custom8>string</Custom8>
<Custom9>string</Custom9>
<Custom10>string</Custom10>
<Custom11>string</Custom11>
<Custom12>string</Custom12>
<Custom13>string</Custom13>
<Custom14>string</Custom14>
<Custom15>string</Custom15>
<Custom16>string</Custom16>
<Custom17>string</Custom17>
<Custom18>string</Custom18>
<Custom19>string</Custom19>
<Custom20>string</Custom20>
<DefaultEmployeeID>string</DefaultEmployeeID>
<DefaultExpenseTypeName>string</DefaultExpenseTypeName>
<DiscountPercentage>string</DiscountPercentage>
<DiscountTermsDays>string</DiscountTermsDays>
<ID>string</ID>
<IsLineItemVatIncld>string</IsLineItemVatIncld>
<IsVisibleForContentExtraction>string</IsVisibleForContentExtraction>
<PaymentMethodType>string</PaymentMethodType>
<PaymentTerms>string</PaymentTerms>
<PostalCode>string</PostalCode>
<ProvincialTaxID>string</ProvincialTaxID>
<PurchaseOrderContactEmail>string</PurchaseOrderContactEmail>
<PurchaseOrderContactFirstName>string</PurchaseOrderContactFirstName>
<PurchaseOrderContactLastName>string</PurchaseOrderContactLastName>
<PurchaseOrderContactPhoneNumber>string</PurchaseOrderContactPhoneNumber>
<ShippingMethod>string</ShippingMethod>
<ShippingTerms>string</ShippingTerms>
<State>string</State>
<StatusList>
<Code>0</Code>
<Message>string</Message>
<RecordNumber>0</RecordNumber>
<Type>string</Type>
</StatusList>
<TaxID>string</TaxID>
<TaxType>string</TaxType>
<URI>string</URI>
<VendorBankList>
<AccountNumber>string</AccountNumber>
<AccountType>string</AccountType>
<AddressCode>string</AddressCode>
<BankCode>string</BankCode>
<BankName>string</BankName>
<BranchCode>string</BranchCode>
<BranchLocation>string</BranchLocation>
<CountryCode>string</CountryCode>
<CurrencyAlphaCode>string</CurrencyAlphaCode>
<ID>string</ID>
<IsActive>string</IsActive>
<NameOnAccount>string</NameOnAccount>
<RoutingNumber>string</RoutingNumber>
<StatusList>
<Code>0</Code>
<Message>string</Message>
<RecordNumber>0</RecordNumber>
<Type>string</Type>
</StatusList>
<TransType>string</TransType>
<URI>string</URI>
<VendorCode>string</VendorCode>
</VendorBankList>
<VendorCode>string</VendorCode>
<VendorFormName>string</VendorFormName>
<VendorGroupList>string</VendorGroupList>
<VendorName>string</VendorName>
<VoucherNotes>string</VoucherNotes>
</Vendor>
<NextPage>string</NextPage>
<RequestRunSummary>string</RequestRunSummary>
<TotalCount>0</TotalCount>
<Items/>
</VendorCollection>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | VendorCollection |
post__invoice_vendors
Code samples
# You can also use wget
curl -X POST https://www.concursolutions.com/api/v3.0/invoice/vendors \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
POST https://www.concursolutions.com/api/v3.0/invoice/vendors HTTP/1.1
Host: www.concursolutions.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"Vendor": {
"AccountNumber": "string",
"Address1": "string",
"Address2": "string",
"Address3": "string",
"AddressCode": "string",
"AddressImportSyncID": "string",
"Approved": "string",
"City": "string",
"ContactEmail": "string",
"ContactFirstName": "string",
"ContactLastName": "string",
"ContactPhoneNumber": "string",
"Country": "string",
"CountryCode": "string",
"CurrencyCode": "string",
"Custom1": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"DefaultEmployeeID": "string",
"DefaultExpenseTypeName": "string",
"DiscountPercentage": "string",
"DiscountTermsDays": "string",
"ID": "string",
"IsLineItemVatIncld": "string",
"IsVisibleForContentExtraction": "string",
"PaymentMethodType": "string",
"PaymentTerms": "string",
"PostalCode": "string",
"ProvincialTaxID": "string",
"PurchaseOrderContactEmail": "string",
"PurchaseOrderContactFirstName": "string",
"PurchaseOrderContactLastName": "string",
"PurchaseOrderContactPhoneNumber": "string",
"ShippingMethod": "string",
"ShippingTerms": "string",
"State": "string",
"StatusList": {
"Code": 0,
"Message": "string",
"RecordNumber": 0,
"Type": "string"
},
"TaxID": "string",
"TaxType": "string",
"URI": "string",
"VendorBankList": {
"AccountNumber": "string",
"AccountType": "string",
"AddressCode": "string",
"BankCode": "string",
"BankName": "string",
"BranchCode": "string",
"BranchLocation": "string",
"CountryCode": "string",
"CurrencyAlphaCode": "string",
"ID": "string",
"IsActive": "string",
"NameOnAccount": "string",
"RoutingNumber": "string",
"StatusList": {
"Code": 0,
"Message": "string",
"RecordNumber": 0,
"Type": "string"
},
"TransType": "string",
"URI": "string",
"VendorCode": "string"
},
"VendorCode": "string",
"VendorFormName": "string",
"VendorGroupList": [
"string"
],
"VendorName": "string",
"VoucherNotes": "string"
},
"NextPage": "string",
"RequestRunSummary": "string",
"TotalCount": 0,
"Items": null
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://www.concursolutions.com/api/v3.0/invoice/vendors',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://www.concursolutions.com/api/v3.0/invoice/vendors',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://www.concursolutions.com/api/v3.0/invoice/vendors', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://www.concursolutions.com/api/v3.0/invoice/vendors', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/invoice/vendors");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://www.concursolutions.com/api/v3.0/invoice/vendors", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /invoice/vendors
Creates new vendors.
Creates a new vendor and returns the status of creation.
Body parameter
{
"Vendor": {
"AccountNumber": "string",
"Address1": "string",
"Address2": "string",
"Address3": "string",
"AddressCode": "string",
"AddressImportSyncID": "string",
"Approved": "string",
"City": "string",
"ContactEmail": "string",
"ContactFirstName": "string",
"ContactLastName": "string",
"ContactPhoneNumber": "string",
"Country": "string",
"CountryCode": "string",
"CurrencyCode": "string",
"Custom1": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"DefaultEmployeeID": "string",
"DefaultExpenseTypeName": "string",
"DiscountPercentage": "string",
"DiscountTermsDays": "string",
"ID": "string",
"IsLineItemVatIncld": "string",
"IsVisibleForContentExtraction": "string",
"PaymentMethodType": "string",
"PaymentTerms": "string",
"PostalCode": "string",
"ProvincialTaxID": "string",
"PurchaseOrderContactEmail": "string",
"PurchaseOrderContactFirstName": "string",
"PurchaseOrderContactLastName": "string",
"PurchaseOrderContactPhoneNumber": "string",
"ShippingMethod": "string",
"ShippingTerms": "string",
"State": "string",
"StatusList": {
"Code": 0,
"Message": "string",
"RecordNumber": 0,
"Type": "string"
},
"TaxID": "string",
"TaxType": "string",
"URI": "string",
"VendorBankList": {
"AccountNumber": "string",
"AccountType": "string",
"AddressCode": "string",
"BankCode": "string",
"BankName": "string",
"BranchCode": "string",
"BranchLocation": "string",
"CountryCode": "string",
"CurrencyAlphaCode": "string",
"ID": "string",
"IsActive": "string",
"NameOnAccount": "string",
"RoutingNumber": "string",
"StatusList": {
"Code": 0,
"Message": "string",
"RecordNumber": 0,
"Type": "string"
},
"TransType": "string",
"URI": "string",
"VendorCode": "string"
},
"VendorCode": "string",
"VendorFormName": "string",
"VendorGroupList": [
"string"
],
"VendorName": "string",
"VoucherNotes": "string"
},
"NextPage": "string",
"RequestRunSummary": "string",
"TotalCount": 0,
"Items": null
}
<?xml version="1.0" encoding="UTF-8" ?>
<VendorCollection>
<Vendor>
<AccountNumber>string</AccountNumber>
<Address1>string</Address1>
<Address2>string</Address2>
<Address3>string</Address3>
<AddressCode>string</AddressCode>
<AddressImportSyncID>string</AddressImportSyncID>
<Approved>string</Approved>
<City>string</City>
<ContactEmail>string</ContactEmail>
<ContactFirstName>string</ContactFirstName>
<ContactLastName>string</ContactLastName>
<ContactPhoneNumber>string</ContactPhoneNumber>
<Country>string</Country>
<CountryCode>string</CountryCode>
<CurrencyCode>string</CurrencyCode>
<Custom1>string</Custom1>
<Custom2>string</Custom2>
<Custom3>string</Custom3>
<Custom4>string</Custom4>
<Custom5>string</Custom5>
<Custom6>string</Custom6>
<Custom7>string</Custom7>
<Custom8>string</Custom8>
<Custom9>string</Custom9>
<Custom10>string</Custom10>
<Custom11>string</Custom11>
<Custom12>string</Custom12>
<Custom13>string</Custom13>
<Custom14>string</Custom14>
<Custom15>string</Custom15>
<Custom16>string</Custom16>
<Custom17>string</Custom17>
<Custom18>string</Custom18>
<Custom19>string</Custom19>
<Custom20>string</Custom20>
<DefaultEmployeeID>string</DefaultEmployeeID>
<DefaultExpenseTypeName>string</DefaultExpenseTypeName>
<DiscountPercentage>string</DiscountPercentage>
<DiscountTermsDays>string</DiscountTermsDays>
<ID>string</ID>
<IsLineItemVatIncld>string</IsLineItemVatIncld>
<IsVisibleForContentExtraction>string</IsVisibleForContentExtraction>
<PaymentMethodType>string</PaymentMethodType>
<PaymentTerms>string</PaymentTerms>
<PostalCode>string</PostalCode>
<ProvincialTaxID>string</ProvincialTaxID>
<PurchaseOrderContactEmail>string</PurchaseOrderContactEmail>
<PurchaseOrderContactFirstName>string</PurchaseOrderContactFirstName>
<PurchaseOrderContactLastName>string</PurchaseOrderContactLastName>
<PurchaseOrderContactPhoneNumber>string</PurchaseOrderContactPhoneNumber>
<ShippingMethod>string</ShippingMethod>
<ShippingTerms>string</ShippingTerms>
<State>string</State>
<StatusList>
<Code>0</Code>
<Message>string</Message>
<RecordNumber>0</RecordNumber>
<Type>string</Type>
</StatusList>
<TaxID>string</TaxID>
<TaxType>string</TaxType>
<URI>string</URI>
<VendorBankList>
<AccountNumber>string</AccountNumber>
<AccountType>string</AccountType>
<AddressCode>string</AddressCode>
<BankCode>string</BankCode>
<BankName>string</BankName>
<BranchCode>string</BranchCode>
<BranchLocation>string</BranchLocation>
<CountryCode>string</CountryCode>
<CurrencyAlphaCode>string</CurrencyAlphaCode>
<ID>string</ID>
<IsActive>string</IsActive>
<NameOnAccount>string</NameOnAccount>
<RoutingNumber>string</RoutingNumber>
<StatusList>
<Code>0</Code>
<Message>string</Message>
<RecordNumber>0</RecordNumber>
<Type>string</Type>
</StatusList>
<TransType>string</TransType>
<URI>string</URI>
<VendorCode>string</VendorCode>
</VendorBankList>
<VendorCode>string</VendorCode>
<VendorFormName>string</VendorFormName>
<VendorGroupList>string</VendorGroupList>
<VendorName>string</VendorName>
<VoucherNotes>string</VoucherNotes>
</Vendor>
<NextPage>string</NextPage>
<RequestRunSummary>string</RequestRunSummary>
<TotalCount>0</TotalCount>
<Items/>
</VendorCollection>
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | VendorCollection | true | The vendor details. |
Example responses
200 Response
{
"Vendor": {
"AccountNumber": "string",
"Address1": "string",
"Address2": "string",
"Address3": "string",
"AddressCode": "string",
"AddressImportSyncID": "string",
"Approved": "string",
"City": "string",
"ContactEmail": "string",
"ContactFirstName": "string",
"ContactLastName": "string",
"ContactPhoneNumber": "string",
"Country": "string",
"CountryCode": "string",
"CurrencyCode": "string",
"Custom1": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"DefaultEmployeeID": "string",
"DefaultExpenseTypeName": "string",
"DiscountPercentage": "string",
"DiscountTermsDays": "string",
"ID": "string",
"IsLineItemVatIncld": "string",
"IsVisibleForContentExtraction": "string",
"PaymentMethodType": "string",
"PaymentTerms": "string",
"PostalCode": "string",
"ProvincialTaxID": "string",
"PurchaseOrderContactEmail": "string",
"PurchaseOrderContactFirstName": "string",
"PurchaseOrderContactLastName": "string",
"PurchaseOrderContactPhoneNumber": "string",
"ShippingMethod": "string",
"ShippingTerms": "string",
"State": "string",
"StatusList": {
"Code": 0,
"Message": "string",
"RecordNumber": 0,
"Type": "string"
},
"TaxID": "string",
"TaxType": "string",
"URI": "string",
"VendorBankList": {
"AccountNumber": "string",
"AccountType": "string",
"AddressCode": "string",
"BankCode": "string",
"BankName": "string",
"BranchCode": "string",
"BranchLocation": "string",
"CountryCode": "string",
"CurrencyAlphaCode": "string",
"ID": "string",
"IsActive": "string",
"NameOnAccount": "string",
"RoutingNumber": "string",
"StatusList": {
"Code": 0,
"Message": "string",
"RecordNumber": 0,
"Type": "string"
},
"TransType": "string",
"URI": "string",
"VendorCode": "string"
},
"VendorCode": "string",
"VendorFormName": "string",
"VendorGroupList": [
"string"
],
"VendorName": "string",
"VoucherNotes": "string"
},
"NextPage": "string",
"RequestRunSummary": "string",
"TotalCount": 0,
"Items": null
}
<?xml version="1.0" encoding="UTF-8" ?>
<VendorCollection>
<Vendor>
<AccountNumber>string</AccountNumber>
<Address1>string</Address1>
<Address2>string</Address2>
<Address3>string</Address3>
<AddressCode>string</AddressCode>
<AddressImportSyncID>string</AddressImportSyncID>
<Approved>string</Approved>
<City>string</City>
<ContactEmail>string</ContactEmail>
<ContactFirstName>string</ContactFirstName>
<ContactLastName>string</ContactLastName>
<ContactPhoneNumber>string</ContactPhoneNumber>
<Country>string</Country>
<CountryCode>string</CountryCode>
<CurrencyCode>string</CurrencyCode>
<Custom1>string</Custom1>
<Custom2>string</Custom2>
<Custom3>string</Custom3>
<Custom4>string</Custom4>
<Custom5>string</Custom5>
<Custom6>string</Custom6>
<Custom7>string</Custom7>
<Custom8>string</Custom8>
<Custom9>string</Custom9>
<Custom10>string</Custom10>
<Custom11>string</Custom11>
<Custom12>string</Custom12>
<Custom13>string</Custom13>
<Custom14>string</Custom14>
<Custom15>string</Custom15>
<Custom16>string</Custom16>
<Custom17>string</Custom17>
<Custom18>string</Custom18>
<Custom19>string</Custom19>
<Custom20>string</Custom20>
<DefaultEmployeeID>string</DefaultEmployeeID>
<DefaultExpenseTypeName>string</DefaultExpenseTypeName>
<DiscountPercentage>string</DiscountPercentage>
<DiscountTermsDays>string</DiscountTermsDays>
<ID>string</ID>
<IsLineItemVatIncld>string</IsLineItemVatIncld>
<IsVisibleForContentExtraction>string</IsVisibleForContentExtraction>
<PaymentMethodType>string</PaymentMethodType>
<PaymentTerms>string</PaymentTerms>
<PostalCode>string</PostalCode>
<ProvincialTaxID>string</ProvincialTaxID>
<PurchaseOrderContactEmail>string</PurchaseOrderContactEmail>
<PurchaseOrderContactFirstName>string</PurchaseOrderContactFirstName>
<PurchaseOrderContactLastName>string</PurchaseOrderContactLastName>
<PurchaseOrderContactPhoneNumber>string</PurchaseOrderContactPhoneNumber>
<ShippingMethod>string</ShippingMethod>
<ShippingTerms>string</ShippingTerms>
<State>string</State>
<StatusList>
<Code>0</Code>
<Message>string</Message>
<RecordNumber>0</RecordNumber>
<Type>string</Type>
</StatusList>
<TaxID>string</TaxID>
<TaxType>string</TaxType>
<URI>string</URI>
<VendorBankList>
<AccountNumber>string</AccountNumber>
<AccountType>string</AccountType>
<AddressCode>string</AddressCode>
<BankCode>string</BankCode>
<BankName>string</BankName>
<BranchCode>string</BranchCode>
<BranchLocation>string</BranchLocation>
<CountryCode>string</CountryCode>
<CurrencyAlphaCode>string</CurrencyAlphaCode>
<ID>string</ID>
<IsActive>string</IsActive>
<NameOnAccount>string</NameOnAccount>
<RoutingNumber>string</RoutingNumber>
<StatusList>
<Code>0</Code>
<Message>string</Message>
<RecordNumber>0</RecordNumber>
<Type>string</Type>
</StatusList>
<TransType>string</TransType>
<URI>string</URI>
<VendorCode>string</VendorCode>
</VendorBankList>
<VendorCode>string</VendorCode>
<VendorFormName>string</VendorFormName>
<VendorGroupList>string</VendorGroupList>
<VendorName>string</VendorName>
<VoucherNotes>string</VoucherNotes>
</Vendor>
<NextPage>string</NextPage>
<RequestRunSummary>string</RequestRunSummary>
<TotalCount>0</TotalCount>
<Items/>
</VendorCollection>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | VendorCollection |
put__invoice_vendors
Code samples
# You can also use wget
curl -X PUT https://www.concursolutions.com/api/v3.0/invoice/vendors \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
PUT https://www.concursolutions.com/api/v3.0/invoice/vendors HTTP/1.1
Host: www.concursolutions.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"Vendor": {
"AccountNumber": "string",
"Address1": "string",
"Address2": "string",
"Address3": "string",
"AddressCode": "string",
"AddressImportSyncID": "string",
"Approved": "string",
"City": "string",
"ContactEmail": "string",
"ContactFirstName": "string",
"ContactLastName": "string",
"ContactPhoneNumber": "string",
"Country": "string",
"CountryCode": "string",
"CurrencyCode": "string",
"Custom1": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"DefaultEmployeeID": "string",
"DefaultExpenseTypeName": "string",
"DiscountPercentage": "string",
"DiscountTermsDays": "string",
"ID": "string",
"IsLineItemVatIncld": "string",
"IsVisibleForContentExtraction": "string",
"PaymentMethodType": "string",
"PaymentTerms": "string",
"PostalCode": "string",
"ProvincialTaxID": "string",
"PurchaseOrderContactEmail": "string",
"PurchaseOrderContactFirstName": "string",
"PurchaseOrderContactLastName": "string",
"PurchaseOrderContactPhoneNumber": "string",
"ShippingMethod": "string",
"ShippingTerms": "string",
"State": "string",
"StatusList": {
"Code": 0,
"Message": "string",
"RecordNumber": 0,
"Type": "string"
},
"TaxID": "string",
"TaxType": "string",
"URI": "string",
"VendorBankList": {
"AccountNumber": "string",
"AccountType": "string",
"AddressCode": "string",
"BankCode": "string",
"BankName": "string",
"BranchCode": "string",
"BranchLocation": "string",
"CountryCode": "string",
"CurrencyAlphaCode": "string",
"ID": "string",
"IsActive": "string",
"NameOnAccount": "string",
"RoutingNumber": "string",
"StatusList": {
"Code": 0,
"Message": "string",
"RecordNumber": 0,
"Type": "string"
},
"TransType": "string",
"URI": "string",
"VendorCode": "string"
},
"VendorCode": "string",
"VendorFormName": "string",
"VendorGroupList": [
"string"
],
"VendorName": "string",
"VoucherNotes": "string"
},
"NextPage": "string",
"RequestRunSummary": "string",
"TotalCount": 0,
"Items": null
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://www.concursolutions.com/api/v3.0/invoice/vendors',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.put 'https://www.concursolutions.com/api/v3.0/invoice/vendors',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.put('https://www.concursolutions.com/api/v3.0/invoice/vendors', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','https://www.concursolutions.com/api/v3.0/invoice/vendors', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/invoice/vendors");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://www.concursolutions.com/api/v3.0/invoice/vendors", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /invoice/vendors
Manages existing vendors.
Updates existing vendors and returns the update status.
Body parameter
{
"Vendor": {
"AccountNumber": "string",
"Address1": "string",
"Address2": "string",
"Address3": "string",
"AddressCode": "string",
"AddressImportSyncID": "string",
"Approved": "string",
"City": "string",
"ContactEmail": "string",
"ContactFirstName": "string",
"ContactLastName": "string",
"ContactPhoneNumber": "string",
"Country": "string",
"CountryCode": "string",
"CurrencyCode": "string",
"Custom1": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"DefaultEmployeeID": "string",
"DefaultExpenseTypeName": "string",
"DiscountPercentage": "string",
"DiscountTermsDays": "string",
"ID": "string",
"IsLineItemVatIncld": "string",
"IsVisibleForContentExtraction": "string",
"PaymentMethodType": "string",
"PaymentTerms": "string",
"PostalCode": "string",
"ProvincialTaxID": "string",
"PurchaseOrderContactEmail": "string",
"PurchaseOrderContactFirstName": "string",
"PurchaseOrderContactLastName": "string",
"PurchaseOrderContactPhoneNumber": "string",
"ShippingMethod": "string",
"ShippingTerms": "string",
"State": "string",
"StatusList": {
"Code": 0,
"Message": "string",
"RecordNumber": 0,
"Type": "string"
},
"TaxID": "string",
"TaxType": "string",
"URI": "string",
"VendorBankList": {
"AccountNumber": "string",
"AccountType": "string",
"AddressCode": "string",
"BankCode": "string",
"BankName": "string",
"BranchCode": "string",
"BranchLocation": "string",
"CountryCode": "string",
"CurrencyAlphaCode": "string",
"ID": "string",
"IsActive": "string",
"NameOnAccount": "string",
"RoutingNumber": "string",
"StatusList": {
"Code": 0,
"Message": "string",
"RecordNumber": 0,
"Type": "string"
},
"TransType": "string",
"URI": "string",
"VendorCode": "string"
},
"VendorCode": "string",
"VendorFormName": "string",
"VendorGroupList": [
"string"
],
"VendorName": "string",
"VoucherNotes": "string"
},
"NextPage": "string",
"RequestRunSummary": "string",
"TotalCount": 0,
"Items": null
}
<?xml version="1.0" encoding="UTF-8" ?>
<VendorCollection>
<Vendor>
<AccountNumber>string</AccountNumber>
<Address1>string</Address1>
<Address2>string</Address2>
<Address3>string</Address3>
<AddressCode>string</AddressCode>
<AddressImportSyncID>string</AddressImportSyncID>
<Approved>string</Approved>
<City>string</City>
<ContactEmail>string</ContactEmail>
<ContactFirstName>string</ContactFirstName>
<ContactLastName>string</ContactLastName>
<ContactPhoneNumber>string</ContactPhoneNumber>
<Country>string</Country>
<CountryCode>string</CountryCode>
<CurrencyCode>string</CurrencyCode>
<Custom1>string</Custom1>
<Custom2>string</Custom2>
<Custom3>string</Custom3>
<Custom4>string</Custom4>
<Custom5>string</Custom5>
<Custom6>string</Custom6>
<Custom7>string</Custom7>
<Custom8>string</Custom8>
<Custom9>string</Custom9>
<Custom10>string</Custom10>
<Custom11>string</Custom11>
<Custom12>string</Custom12>
<Custom13>string</Custom13>
<Custom14>string</Custom14>
<Custom15>string</Custom15>
<Custom16>string</Custom16>
<Custom17>string</Custom17>
<Custom18>string</Custom18>
<Custom19>string</Custom19>
<Custom20>string</Custom20>
<DefaultEmployeeID>string</DefaultEmployeeID>
<DefaultExpenseTypeName>string</DefaultExpenseTypeName>
<DiscountPercentage>string</DiscountPercentage>
<DiscountTermsDays>string</DiscountTermsDays>
<ID>string</ID>
<IsLineItemVatIncld>string</IsLineItemVatIncld>
<IsVisibleForContentExtraction>string</IsVisibleForContentExtraction>
<PaymentMethodType>string</PaymentMethodType>
<PaymentTerms>string</PaymentTerms>
<PostalCode>string</PostalCode>
<ProvincialTaxID>string</ProvincialTaxID>
<PurchaseOrderContactEmail>string</PurchaseOrderContactEmail>
<PurchaseOrderContactFirstName>string</PurchaseOrderContactFirstName>
<PurchaseOrderContactLastName>string</PurchaseOrderContactLastName>
<PurchaseOrderContactPhoneNumber>string</PurchaseOrderContactPhoneNumber>
<ShippingMethod>string</ShippingMethod>
<ShippingTerms>string</ShippingTerms>
<State>string</State>
<StatusList>
<Code>0</Code>
<Message>string</Message>
<RecordNumber>0</RecordNumber>
<Type>string</Type>
</StatusList>
<TaxID>string</TaxID>
<TaxType>string</TaxType>
<URI>string</URI>
<VendorBankList>
<AccountNumber>string</AccountNumber>
<AccountType>string</AccountType>
<AddressCode>string</AddressCode>
<BankCode>string</BankCode>
<BankName>string</BankName>
<BranchCode>string</BranchCode>
<BranchLocation>string</BranchLocation>
<CountryCode>string</CountryCode>
<CurrencyAlphaCode>string</CurrencyAlphaCode>
<ID>string</ID>
<IsActive>string</IsActive>
<NameOnAccount>string</NameOnAccount>
<RoutingNumber>string</RoutingNumber>
<StatusList>
<Code>0</Code>
<Message>string</Message>
<RecordNumber>0</RecordNumber>
<Type>string</Type>
</StatusList>
<TransType>string</TransType>
<URI>string</URI>
<VendorCode>string</VendorCode>
</VendorBankList>
<VendorCode>string</VendorCode>
<VendorFormName>string</VendorFormName>
<VendorGroupList>string</VendorGroupList>
<VendorName>string</VendorName>
<VoucherNotes>string</VoucherNotes>
</Vendor>
<NextPage>string</NextPage>
<RequestRunSummary>string</RequestRunSummary>
<TotalCount>0</TotalCount>
<Items/>
</VendorCollection>
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | VendorCollection | true | The vendor details. |
Example responses
200 Response
{
"Vendor": {
"AccountNumber": "string",
"Address1": "string",
"Address2": "string",
"Address3": "string",
"AddressCode": "string",
"AddressImportSyncID": "string",
"Approved": "string",
"City": "string",
"ContactEmail": "string",
"ContactFirstName": "string",
"ContactLastName": "string",
"ContactPhoneNumber": "string",
"Country": "string",
"CountryCode": "string",
"CurrencyCode": "string",
"Custom1": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"DefaultEmployeeID": "string",
"DefaultExpenseTypeName": "string",
"DiscountPercentage": "string",
"DiscountTermsDays": "string",
"ID": "string",
"IsLineItemVatIncld": "string",
"IsVisibleForContentExtraction": "string",
"PaymentMethodType": "string",
"PaymentTerms": "string",
"PostalCode": "string",
"ProvincialTaxID": "string",
"PurchaseOrderContactEmail": "string",
"PurchaseOrderContactFirstName": "string",
"PurchaseOrderContactLastName": "string",
"PurchaseOrderContactPhoneNumber": "string",
"ShippingMethod": "string",
"ShippingTerms": "string",
"State": "string",
"StatusList": {
"Code": 0,
"Message": "string",
"RecordNumber": 0,
"Type": "string"
},
"TaxID": "string",
"TaxType": "string",
"URI": "string",
"VendorBankList": {
"AccountNumber": "string",
"AccountType": "string",
"AddressCode": "string",
"BankCode": "string",
"BankName": "string",
"BranchCode": "string",
"BranchLocation": "string",
"CountryCode": "string",
"CurrencyAlphaCode": "string",
"ID": "string",
"IsActive": "string",
"NameOnAccount": "string",
"RoutingNumber": "string",
"StatusList": {
"Code": 0,
"Message": "string",
"RecordNumber": 0,
"Type": "string"
},
"TransType": "string",
"URI": "string",
"VendorCode": "string"
},
"VendorCode": "string",
"VendorFormName": "string",
"VendorGroupList": [
"string"
],
"VendorName": "string",
"VoucherNotes": "string"
},
"NextPage": "string",
"RequestRunSummary": "string",
"TotalCount": 0,
"Items": null
}
<?xml version="1.0" encoding="UTF-8" ?>
<VendorCollection>
<Vendor>
<AccountNumber>string</AccountNumber>
<Address1>string</Address1>
<Address2>string</Address2>
<Address3>string</Address3>
<AddressCode>string</AddressCode>
<AddressImportSyncID>string</AddressImportSyncID>
<Approved>string</Approved>
<City>string</City>
<ContactEmail>string</ContactEmail>
<ContactFirstName>string</ContactFirstName>
<ContactLastName>string</ContactLastName>
<ContactPhoneNumber>string</ContactPhoneNumber>
<Country>string</Country>
<CountryCode>string</CountryCode>
<CurrencyCode>string</CurrencyCode>
<Custom1>string</Custom1>
<Custom2>string</Custom2>
<Custom3>string</Custom3>
<Custom4>string</Custom4>
<Custom5>string</Custom5>
<Custom6>string</Custom6>
<Custom7>string</Custom7>
<Custom8>string</Custom8>
<Custom9>string</Custom9>
<Custom10>string</Custom10>
<Custom11>string</Custom11>
<Custom12>string</Custom12>
<Custom13>string</Custom13>
<Custom14>string</Custom14>
<Custom15>string</Custom15>
<Custom16>string</Custom16>
<Custom17>string</Custom17>
<Custom18>string</Custom18>
<Custom19>string</Custom19>
<Custom20>string</Custom20>
<DefaultEmployeeID>string</DefaultEmployeeID>
<DefaultExpenseTypeName>string</DefaultExpenseTypeName>
<DiscountPercentage>string</DiscountPercentage>
<DiscountTermsDays>string</DiscountTermsDays>
<ID>string</ID>
<IsLineItemVatIncld>string</IsLineItemVatIncld>
<IsVisibleForContentExtraction>string</IsVisibleForContentExtraction>
<PaymentMethodType>string</PaymentMethodType>
<PaymentTerms>string</PaymentTerms>
<PostalCode>string</PostalCode>
<ProvincialTaxID>string</ProvincialTaxID>
<PurchaseOrderContactEmail>string</PurchaseOrderContactEmail>
<PurchaseOrderContactFirstName>string</PurchaseOrderContactFirstName>
<PurchaseOrderContactLastName>string</PurchaseOrderContactLastName>
<PurchaseOrderContactPhoneNumber>string</PurchaseOrderContactPhoneNumber>
<ShippingMethod>string</ShippingMethod>
<ShippingTerms>string</ShippingTerms>
<State>string</State>
<StatusList>
<Code>0</Code>
<Message>string</Message>
<RecordNumber>0</RecordNumber>
<Type>string</Type>
</StatusList>
<TaxID>string</TaxID>
<TaxType>string</TaxType>
<URI>string</URI>
<VendorBankList>
<AccountNumber>string</AccountNumber>
<AccountType>string</AccountType>
<AddressCode>string</AddressCode>
<BankCode>string</BankCode>
<BankName>string</BankName>
<BranchCode>string</BranchCode>
<BranchLocation>string</BranchLocation>
<CountryCode>string</CountryCode>
<CurrencyAlphaCode>string</CurrencyAlphaCode>
<ID>string</ID>
<IsActive>string</IsActive>
<NameOnAccount>string</NameOnAccount>
<RoutingNumber>string</RoutingNumber>
<StatusList>
<Code>0</Code>
<Message>string</Message>
<RecordNumber>0</RecordNumber>
<Type>string</Type>
</StatusList>
<TransType>string</TransType>
<URI>string</URI>
<VendorCode>string</VendorCode>
</VendorBankList>
<VendorCode>string</VendorCode>
<VendorFormName>string</VendorFormName>
<VendorGroupList>string</VendorGroupList>
<VendorName>string</VendorName>
<VoucherNotes>string</VoucherNotes>
</Vendor>
<NextPage>string</NextPage>
<RequestRunSummary>string</RequestRunSummary>
<TotalCount>0</TotalCount>
<Items/>
</VendorCollection>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | VendorCollection |
delete__invoice_vendors
Code samples
# You can also use wget
curl -X DELETE https://www.concursolutions.com/api/v3.0/invoice/vendors?vendorCode=string&addressCode=string \
-H 'Accept: application/json'
DELETE https://www.concursolutions.com/api/v3.0/invoice/vendors?vendorCode=string&addressCode=string HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://www.concursolutions.com/api/v3.0/invoice/vendors?vendorCode=string&addressCode=string',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.delete 'https://www.concursolutions.com/api/v3.0/invoice/vendors',
params: {
'vendorCode' => 'string',
'addressCode' => 'string'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.delete('https://www.concursolutions.com/api/v3.0/invoice/vendors', params={
'vendorCode': 'string', 'addressCode': 'string'
}, headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','https://www.concursolutions.com/api/v3.0/invoice/vendors', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.0/invoice/vendors?vendorCode=string&addressCode=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://www.concursolutions.com/api/v3.0/invoice/vendors", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /invoice/vendors
Deletes a vendor.
Deletes a vendor by Vendor Code and Address Code.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| vendorCode | query | string | true | Vendor Code to be deleted |
| addressCode | query | string | true | Address Code to be deleted |
Example responses
200 Response
{
"Vendor": {
"AccountNumber": "string",
"Address1": "string",
"Address2": "string",
"Address3": "string",
"AddressCode": "string",
"AddressImportSyncID": "string",
"Approved": "string",
"City": "string",
"ContactEmail": "string",
"ContactFirstName": "string",
"ContactLastName": "string",
"ContactPhoneNumber": "string",
"Country": "string",
"CountryCode": "string",
"CurrencyCode": "string",
"Custom1": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"DefaultEmployeeID": "string",
"DefaultExpenseTypeName": "string",
"DiscountPercentage": "string",
"DiscountTermsDays": "string",
"ID": "string",
"IsLineItemVatIncld": "string",
"IsVisibleForContentExtraction": "string",
"PaymentMethodType": "string",
"PaymentTerms": "string",
"PostalCode": "string",
"ProvincialTaxID": "string",
"PurchaseOrderContactEmail": "string",
"PurchaseOrderContactFirstName": "string",
"PurchaseOrderContactLastName": "string",
"PurchaseOrderContactPhoneNumber": "string",
"ShippingMethod": "string",
"ShippingTerms": "string",
"State": "string",
"StatusList": {
"Code": 0,
"Message": "string",
"RecordNumber": 0,
"Type": "string"
},
"TaxID": "string",
"TaxType": "string",
"URI": "string",
"VendorBankList": {
"AccountNumber": "string",
"AccountType": "string",
"AddressCode": "string",
"BankCode": "string",
"BankName": "string",
"BranchCode": "string",
"BranchLocation": "string",
"CountryCode": "string",
"CurrencyAlphaCode": "string",
"ID": "string",
"IsActive": "string",
"NameOnAccount": "string",
"RoutingNumber": "string",
"StatusList": {
"Code": 0,
"Message": "string",
"RecordNumber": 0,
"Type": "string"
},
"TransType": "string",
"URI": "string",
"VendorCode": "string"
},
"VendorCode": "string",
"VendorFormName": "string",
"VendorGroupList": [
"string"
],
"VendorName": "string",
"VoucherNotes": "string"
},
"NextPage": "string",
"RequestRunSummary": "string",
"TotalCount": 0,
"Items": null
}
<?xml version="1.0" encoding="UTF-8" ?>
<VendorCollection>
<Vendor>
<AccountNumber>string</AccountNumber>
<Address1>string</Address1>
<Address2>string</Address2>
<Address3>string</Address3>
<AddressCode>string</AddressCode>
<AddressImportSyncID>string</AddressImportSyncID>
<Approved>string</Approved>
<City>string</City>
<ContactEmail>string</ContactEmail>
<ContactFirstName>string</ContactFirstName>
<ContactLastName>string</ContactLastName>
<ContactPhoneNumber>string</ContactPhoneNumber>
<Country>string</Country>
<CountryCode>string</CountryCode>
<CurrencyCode>string</CurrencyCode>
<Custom1>string</Custom1>
<Custom2>string</Custom2>
<Custom3>string</Custom3>
<Custom4>string</Custom4>
<Custom5>string</Custom5>
<Custom6>string</Custom6>
<Custom7>string</Custom7>
<Custom8>string</Custom8>
<Custom9>string</Custom9>
<Custom10>string</Custom10>
<Custom11>string</Custom11>
<Custom12>string</Custom12>
<Custom13>string</Custom13>
<Custom14>string</Custom14>
<Custom15>string</Custom15>
<Custom16>string</Custom16>
<Custom17>string</Custom17>
<Custom18>string</Custom18>
<Custom19>string</Custom19>
<Custom20>string</Custom20>
<DefaultEmployeeID>string</DefaultEmployeeID>
<DefaultExpenseTypeName>string</DefaultExpenseTypeName>
<DiscountPercentage>string</DiscountPercentage>
<DiscountTermsDays>string</DiscountTermsDays>
<ID>string</ID>
<IsLineItemVatIncld>string</IsLineItemVatIncld>
<IsVisibleForContentExtraction>string</IsVisibleForContentExtraction>
<PaymentMethodType>string</PaymentMethodType>
<PaymentTerms>string</PaymentTerms>
<PostalCode>string</PostalCode>
<ProvincialTaxID>string</ProvincialTaxID>
<PurchaseOrderContactEmail>string</PurchaseOrderContactEmail>
<PurchaseOrderContactFirstName>string</PurchaseOrderContactFirstName>
<PurchaseOrderContactLastName>string</PurchaseOrderContactLastName>
<PurchaseOrderContactPhoneNumber>string</PurchaseOrderContactPhoneNumber>
<ShippingMethod>string</ShippingMethod>
<ShippingTerms>string</ShippingTerms>
<State>string</State>
<StatusList>
<Code>0</Code>
<Message>string</Message>
<RecordNumber>0</RecordNumber>
<Type>string</Type>
</StatusList>
<TaxID>string</TaxID>
<TaxType>string</TaxType>
<URI>string</URI>
<VendorBankList>
<AccountNumber>string</AccountNumber>
<AccountType>string</AccountType>
<AddressCode>string</AddressCode>
<BankCode>string</BankCode>
<BankName>string</BankName>
<BranchCode>string</BranchCode>
<BranchLocation>string</BranchLocation>
<CountryCode>string</CountryCode>
<CurrencyAlphaCode>string</CurrencyAlphaCode>
<ID>string</ID>
<IsActive>string</IsActive>
<NameOnAccount>string</NameOnAccount>
<RoutingNumber>string</RoutingNumber>
<StatusList>
<Code>0</Code>
<Message>string</Message>
<RecordNumber>0</RecordNumber>
<Type>string</Type>
</StatusList>
<TransType>string</TransType>
<URI>string</URI>
<VendorCode>string</VendorCode>
</VendorBankList>
<VendorCode>string</VendorCode>
<VendorFormName>string</VendorFormName>
<VendorGroupList>string</VendorGroupList>
<VendorName>string</VendorName>
<VoucherNotes>string</VoucherNotes>
</Vendor>
<NextPage>string</NextPage>
<RequestRunSummary>string</RequestRunSummary>
<TotalCount>0</TotalCount>
<Items/>
</VendorCollection>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | VendorCollection |
Schemas
Status
{
"Code": 0,
"Message": "string",
"RecordNumber": 0,
"Type": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Code | integer(int32) | false | none | Code of request result |
| Message | string | false | none | Message of request result |
| RecordNumber | integer(int32) | false | none | Record Number for create/update request. |
| Type | string | false | none | Type request result |
Vendor
{
"AccountNumber": "string",
"Address1": "string",
"Address2": "string",
"Address3": "string",
"AddressCode": "string",
"AddressImportSyncID": "string",
"Approved": "string",
"City": "string",
"ContactEmail": "string",
"ContactFirstName": "string",
"ContactLastName": "string",
"ContactPhoneNumber": "string",
"Country": "string",
"CountryCode": "string",
"CurrencyCode": "string",
"Custom1": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"DefaultEmployeeID": "string",
"DefaultExpenseTypeName": "string",
"DiscountPercentage": "string",
"DiscountTermsDays": "string",
"ID": "string",
"IsLineItemVatIncld": "string",
"IsVisibleForContentExtraction": "string",
"PaymentMethodType": "string",
"PaymentTerms": "string",
"PostalCode": "string",
"ProvincialTaxID": "string",
"PurchaseOrderContactEmail": "string",
"PurchaseOrderContactFirstName": "string",
"PurchaseOrderContactLastName": "string",
"PurchaseOrderContactPhoneNumber": "string",
"ShippingMethod": "string",
"ShippingTerms": "string",
"State": "string",
"StatusList": {
"Code": 0,
"Message": "string",
"RecordNumber": 0,
"Type": "string"
},
"TaxID": "string",
"TaxType": "string",
"URI": "string",
"VendorBankList": {
"AccountNumber": "string",
"AccountType": "string",
"AddressCode": "string",
"BankCode": "string",
"BankName": "string",
"BranchCode": "string",
"BranchLocation": "string",
"CountryCode": "string",
"CurrencyAlphaCode": "string",
"ID": "string",
"IsActive": "string",
"NameOnAccount": "string",
"RoutingNumber": "string",
"StatusList": {
"Code": 0,
"Message": "string",
"RecordNumber": 0,
"Type": "string"
},
"TransType": "string",
"URI": "string",
"VendorCode": "string"
},
"VendorCode": "string",
"VendorFormName": "string",
"VendorGroupList": [
"string"
],
"VendorName": "string",
"VoucherNotes": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| AccountNumber | string | false | none | The Buyer Account Number. |
| Address1 | string | false | none | The Vendor Address 1. |
| Address2 | string | false | none | The Vendor Address 2. |
| Address3 | string | false | none | The Vendor Address 3. |
| AddressCode | string | false | none | The Address Code. |
| AddressImportSyncID | string | false | none | This ID is originally generated by Invoice when an employee requests a new vendor. The Employee Request Vendor Extract provides this value to positively identify the vendor address record when reimporting vendor from the client's system of record for the Vendor Master List. |
| Approved | string | false | none | Vendor Approval Status. |
| City | string | false | none | The Vendor City. |
| ContactEmail | string | false | none | The Vendor Contact Email. |
| ContactFirstName | string | false | none | The Vendor Contact First Name. |
| ContactLastName | string | false | none | The Vendor Contact Last Name. |
| ContactPhoneNumber | string | false | none | The Vendor Contact Phone Number. |
| Country | string | false | none | The Vendor Country. |
| CountryCode | string | false | none | The Vendor Country Code. |
| CurrencyCode | string | false | none | The Vendor Currency Code. |
| Custom1 | string | false | none | A value that can be applied to a custom field 1 that is part of the vendor form. |
| Custom2 | string | false | none | A value that can be applied to a custom field 10 that is part of the vendor form. |
| Custom3 | string | false | none | A value that can be applied to a custom field 11 that is part of the vendor form. |
| Custom4 | string | false | none | A value that can be applied to a custom field 12 that is part of the vendor form. |
| Custom5 | string | false | none | A value that can be applied to a custom field 13 that is part of the vendor form. |
| Custom6 | string | false | none | A value that can be applied to a custom field 14 that is part of the vendor form. |
| Custom7 | string | false | none | A value that can be applied to a custom field 15 that is part of the vendor form. |
| Custom8 | string | false | none | A value that can be applied to a custom field 16 that is part of the vendor form. |
| Custom9 | string | false | none | A value that can be applied to a custom field 17 that is part of the vendor form. |
| Custom10 | string | false | none | A value that can be applied to a custom field 18 that is part of the vendor form. |
| Custom11 | string | false | none | A value that can be applied to a custom field 19 that is part of the vendor form. |
| Custom12 | string | false | none | A value that can be applied to a custom field 2 that is part of the vendor form. |
| Custom13 | string | false | none | A value that can be applied to a custom field 20 that is part of the vendor form. |
| Custom14 | string | false | none | A value that can be applied to a custom field 3 that is part of the vendor form. |
| Custom15 | string | false | none | A value that can be applied to a custom field 4 that is part of the vendor form. |
| Custom16 | string | false | none | A value that can be applied to a custom field 5 that is part of the vendor form. |
| Custom17 | string | false | none | A value that can be applied to a custom field 6 that is part of the vendor form. |
| Custom18 | string | false | none | A value that can be applied to a custom field 7 that is part of the vendor form. |
| Custom19 | string | false | none | A value that can be applied to a custom field 8 that is part of the vendor form. |
| Custom20 | string | false | none | A value that can be applied to a custom field 9 that is part of the vendor form. |
| DefaultEmployeeID | string | false | none | The Default Employee ID of the employee connected to the vendor. |
| DefaultExpenseTypeName | string | false | none | The Default Expense Type tied to the vendor. |
| DiscountPercentage | string | false | none | The Discount Percentage. |
| DiscountTermsDays | string | false | none | The Vendor Discount Terms Days. |
| ID | string | false | none | The unique identifier of the resource. |
| IsLineItemVatIncld | string | false | none | Line item Unit Price Contains VAT |
| IsVisibleForContentExtraction | string | false | none | Flag that indicates if the vendor will be available for OCR within Brainware |
| PaymentMethodType | string | false | none | Preferred Payment Type for Vendor. |
| PaymentTerms | string | false | none | The Vendor Payment Terms. |
| PostalCode | string | false | none | The Vendor Postal Code / Zip. |
| ProvincialTaxID | string | false | none | The Vendor Provincial Tax ID. Note that this value is not encrypted at REST. |
| PurchaseOrderContactEmail | string | false | none | The Purchase Order Contact Email. |
| PurchaseOrderContactFirstName | string | false | none | The Purchase Order Contact First Name. |
| PurchaseOrderContactLastName | string | false | none | The Purchase Order Contact Last Name. |
| PurchaseOrderContactPhoneNumber | string | false | none | The Purchase Order Contact Phone Number. |
| ShippingMethod | string | false | none | The Vendor Shipping Method. |
| ShippingTerms | string | false | none | The Vendor Shipping Terms. |
| State | string | false | none | The Vendor State. |
| StatusList | Status | false | none | none |
| TaxID | string | false | none | The Vendor Tax ID. Note that this value is not encrypted at REST. |
| TaxType | string | false | none | The Vendor Tax Type. |
| URI | string | false | none | The URI to the resource. |
| VendorBankList | VendorBank | false | none | none |
| VendorCode | string | false | none | The vendor code of the request. |
| VendorFormName | string | false | none | The vendor form name this vendor is associated with. |
| VendorGroupList | [string] | false | none | The list of vendor groups by name. |
| VendorName | string | false | none | The name of the vendor. |
| VoucherNotes | string | false | none | Notes sent to Vendor along with authorization to charge Card Voucher. |
VendorBank
{
"AccountNumber": "string",
"AccountType": "string",
"AddressCode": "string",
"BankCode": "string",
"BankName": "string",
"BranchCode": "string",
"BranchLocation": "string",
"CountryCode": "string",
"CurrencyAlphaCode": "string",
"ID": "string",
"IsActive": "string",
"NameOnAccount": "string",
"RoutingNumber": "string",
"StatusList": {
"Code": 0,
"Message": "string",
"RecordNumber": 0,
"Type": "string"
},
"TransType": "string",
"URI": "string",
"VendorCode": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| AccountNumber | string | false | none | The account number. |
| AccountType | string | false | none | The account type. |
| AddressCode | string | false | none | The Address Code. |
| BankCode | string | false | none | Bank Code |
| BankName | string | false | none | The bank name. |
| BranchCode | string | false | none | Branch Code |
| BranchLocation | string | false | none | The branch location |
| CountryCode | string | false | none | The country code. |
| CurrencyAlphaCode | string | false | none | The currency alpha Code. |
| ID | string | false | none | The unique identifier of the resource. |
| IsActive | string | false | none | Is information active |
| NameOnAccount | string | false | none | The name on the account. |
| RoutingNumber | string | false | none | The routing number. |
| StatusList | Status | false | none | none |
| TransType | string | false | none | The trans type. |
| URI | string | false | none | The URI to the resource. |
| VendorCode | string | false | none | The vendor code of the request. |
VendorCollection
{
"Vendor": {
"AccountNumber": "string",
"Address1": "string",
"Address2": "string",
"Address3": "string",
"AddressCode": "string",
"AddressImportSyncID": "string",
"Approved": "string",
"City": "string",
"ContactEmail": "string",
"ContactFirstName": "string",
"ContactLastName": "string",
"ContactPhoneNumber": "string",
"Country": "string",
"CountryCode": "string",
"CurrencyCode": "string",
"Custom1": "string",
"Custom2": "string",
"Custom3": "string",
"Custom4": "string",
"Custom5": "string",
"Custom6": "string",
"Custom7": "string",
"Custom8": "string",
"Custom9": "string",
"Custom10": "string",
"Custom11": "string",
"Custom12": "string",
"Custom13": "string",
"Custom14": "string",
"Custom15": "string",
"Custom16": "string",
"Custom17": "string",
"Custom18": "string",
"Custom19": "string",
"Custom20": "string",
"DefaultEmployeeID": "string",
"DefaultExpenseTypeName": "string",
"DiscountPercentage": "string",
"DiscountTermsDays": "string",
"ID": "string",
"IsLineItemVatIncld": "string",
"IsVisibleForContentExtraction": "string",
"PaymentMethodType": "string",
"PaymentTerms": "string",
"PostalCode": "string",
"ProvincialTaxID": "string",
"PurchaseOrderContactEmail": "string",
"PurchaseOrderContactFirstName": "string",
"PurchaseOrderContactLastName": "string",
"PurchaseOrderContactPhoneNumber": "string",
"ShippingMethod": "string",
"ShippingTerms": "string",
"State": "string",
"StatusList": {
"Code": 0,
"Message": "string",
"RecordNumber": 0,
"Type": "string"
},
"TaxID": "string",
"TaxType": "string",
"URI": "string",
"VendorBankList": {
"AccountNumber": "string",
"AccountType": "string",
"AddressCode": "string",
"BankCode": "string",
"BankName": "string",
"BranchCode": "string",
"BranchLocation": "string",
"CountryCode": "string",
"CurrencyAlphaCode": "string",
"ID": "string",
"IsActive": "string",
"NameOnAccount": "string",
"RoutingNumber": "string",
"StatusList": {
"Code": 0,
"Message": "string",
"RecordNumber": 0,
"Type": "string"
},
"TransType": "string",
"URI": "string",
"VendorCode": "string"
},
"VendorCode": "string",
"VendorFormName": "string",
"VendorGroupList": [
"string"
],
"VendorName": "string",
"VoucherNotes": "string"
},
"NextPage": "string",
"RequestRunSummary": "string",
"TotalCount": 0,
"Items": null
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Vendor | Vendor | false | none | none |
| NextPage | string | false | none | The URI of the next page of results, if any. |
| RequestRunSummary | string | false | none | The URI of the next page of results, if any. |
| TotalCount | integer(int32) | false | none | Record Number for create/update request. |
| Items | any | false | none | none |
Version 3.1
Connection Requests v3.1
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
TripLink allows travel suppliers to send itinerary data for connected users directly to Concur. This API allows TripLink suppliers to view, create, and update connection requests from Concur users.
Base URLs:
Resources
get__common_connectionrequests
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.1/common/connectionrequests \
-H 'Accept: application/json'
GET https://www.concursolutions.com/api/v3.1/common/connectionrequests HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://www.concursolutions.com/api/v3.1/common/connectionrequests',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.1/common/connectionrequests',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://www.concursolutions.com/api/v3.1/common/connectionrequests', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.1/common/connectionrequests', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.1/common/connectionrequests");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.1/common/connectionrequests", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /common/connectionrequests
Get all connection requests
Gets all connection requests that match the TripLink supplier ID.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| offset | query | string | false | The starting point of the next set of results, after the limit specified in the limit field has been reached. The default is the beginning of the page. |
| limit | query | integer(int32) | false | The number of records to return. The default is 5 and the maximum is 10. |
| status | query | string | false | The status code representing the state of the connection request. The possible values are Pending, Processing, Connected, Failed, and Retry. |
Example responses
200 Response
{
"Items": {
"FirstName": "string",
"ID": "string",
"LastModified": "string",
"LastName": "string",
"LoyaltyNumber": "string",
"MiddleName": "string",
"RequestToken": "string",
"Status": "string",
"URI": "string",
"EmailAddresses": {
"Email1": "string",
"Email2": "string",
"Email3": "string",
"Email4": "string",
"Email5": "string"
}
},
"NextPage": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ConnectionRequestCollection>
<Items>
<FirstName>string</FirstName>
<ID>string</ID>
<LastModified>string</LastModified>
<LastName>string</LastName>
<LoyaltyNumber>string</LoyaltyNumber>
<MiddleName>string</MiddleName>
<RequestToken>string</RequestToken>
<Status>string</Status>
<URI>string</URI>
<EmailAddresses>
<Email1>string</Email1>
<Email2>string</Email2>
<Email3>string</Email3>
<Email4>string</Email4>
<Email5>string</Email5>
</EmailAddresses>
</Items>
<NextPage>string</NextPage>
</ConnectionRequestCollection>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ConnectionRequestCollection |
post__common_connectionrequests
Code samples
# You can also use wget
curl -X POST https://www.concursolutions.com/api/v3.1/common/connectionrequests?user=string \
-H 'Accept: application/json'
POST https://www.concursolutions.com/api/v3.1/common/connectionrequests?user=string HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://www.concursolutions.com/api/v3.1/common/connectionrequests?user=string',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.post 'https://www.concursolutions.com/api/v3.1/common/connectionrequests',
params: {
'user' => 'string'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.post('https://www.concursolutions.com/api/v3.1/common/connectionrequests', params={
'user': 'string'
}, headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://www.concursolutions.com/api/v3.1/common/connectionrequests', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.1/common/connectionrequests?user=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://www.concursolutions.com/api/v3.1/common/connectionrequests", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /common/connectionrequests
Create a connection request
Creates a connection request on behalf of the specified user.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| user | query | string | true | The login ID of the user for whom to create the connection request. The user must have the Web Services Admin role to use this parameter. |
Example responses
200 Response
{
"ID": "string",
"URI": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CreateResponse>
<ID>string</ID>
<URI>string</URI>
</CreateResponse>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | CreateResponse |
get_common_connectionrequests{id}
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v3.1/common/connectionrequests/{id} \
-H 'Accept: application/json'
GET https://www.concursolutions.com/api/v3.1/common/connectionrequests/{id} HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://www.concursolutions.com/api/v3.1/common/connectionrequests/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://www.concursolutions.com/api/v3.1/common/connectionrequests/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://www.concursolutions.com/api/v3.1/common/connectionrequests/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v3.1/common/connectionrequests/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.1/common/connectionrequests/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v3.1/common/connectionrequests/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /common/connectionrequests/{id}
Get a connection request by ID
Gets a connection request by ID.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The connection request ID. |
Example responses
200 Response
{
"FirstName": "string",
"ID": "string",
"LastModified": "string",
"LastName": "string",
"LoyaltyNumber": "string",
"MiddleName": "string",
"RequestToken": "string",
"Status": "string",
"URI": "string",
"EmailAddresses": {
"Email1": "string",
"Email2": "string",
"Email3": "string",
"Email4": "string",
"Email5": "string"
}
}
<?xml version="1.0" encoding="UTF-8" ?>
<ConnectionRequestGet>
<FirstName>string</FirstName>
<ID>string</ID>
<LastModified>string</LastModified>
<LastName>string</LastName>
<LoyaltyNumber>string</LoyaltyNumber>
<MiddleName>string</MiddleName>
<RequestToken>string</RequestToken>
<Status>string</Status>
<URI>string</URI>
<EmailAddresses>
<Email1>string</Email1>
<Email2>string</Email2>
<Email3>string</Email3>
<Email4>string</Email4>
<Email5>string</Email5>
</EmailAddresses>
</ConnectionRequestGet>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ConnectionRequestGet |
put_common_connectionrequests{id}
Code samples
# You can also use wget
curl -X PUT https://www.concursolutions.com/api/v3.1/common/connectionrequests/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
PUT https://www.concursolutions.com/api/v3.1/common/connectionrequests/{id} HTTP/1.1
Host: www.concursolutions.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"Status": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://www.concursolutions.com/api/v3.1/common/connectionrequests/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.put 'https://www.concursolutions.com/api/v3.1/common/connectionrequests/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.put('https://www.concursolutions.com/api/v3.1/common/connectionrequests/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','https://www.concursolutions.com/api/v3.1/common/connectionrequests/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v3.1/common/connectionrequests/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://www.concursolutions.com/api/v3.1/common/connectionrequests/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /common/connectionrequests/{id}
Update a connection request by ID
Updates the specified connection request. Only the fields provided in the supplied object are updated. Missing fields will not be altered.
Body parameter
{
"Status": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ConnectionRequestPut>
<Status>string</Status>
</ConnectionRequestPut>
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The connection request ID. |
| body | body | ConnectionRequestPut | true | The connection request object to update. |
Example responses
200 Response
{}
<?xml version="1.0" encoding="UTF-8" ?>
<Void/>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Void |
Schemas
ConnectionRequestCollection
{
"Items": {
"FirstName": "string",
"ID": "string",
"LastModified": "string",
"LastName": "string",
"LoyaltyNumber": "string",
"MiddleName": "string",
"RequestToken": "string",
"Status": "string",
"URI": "string",
"EmailAddresses": {
"Email1": "string",
"Email2": "string",
"Email3": "string",
"Email4": "string",
"Email5": "string"
}
},
"NextPage": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Items | ConnectionRequestGet | false | none | none |
| NextPage | string | false | none | If provided, the URI for the next GET call. |
ConnectionRequestGet
{
"FirstName": "string",
"ID": "string",
"LastModified": "string",
"LastName": "string",
"LoyaltyNumber": "string",
"MiddleName": "string",
"RequestToken": "string",
"Status": "string",
"URI": "string",
"EmailAddresses": {
"Email1": "string",
"Email2": "string",
"Email3": "string",
"Email4": "string",
"Email5": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| FirstName | string | false | none | The first name of the user for whom the connection request is for. |
| ID | string | false | none | The unique identifier for the connection request. |
| LastModified | string | false | none | The UTC date representing when this connection rerquest was last modified. Format: YY-MM-DDTHH:MM:SS |
| LastName | string | false | none | The last name of the user for whom the connection request is for. |
| LoyaltyNumber | string | false | none | The user's loyalty number. |
| MiddleName | string | false | none | The middle name of the user for whom the connection request is for. |
| RequestToken | string | false | none | OAuth2 request token with a limited lifetime (15 minutes) that may be exchanged for an access token. |
| Status | string | false | none | The status code representing the state of the connection request. The possible values are: CRSUC - The supplier indicated that the connection was made successfully. CREU1 - The loyalty number was not found. CREU2 - The loyalty number doesn't match the name. CREU3 - Your loyalty account requires attention. CRPA1 - The request token has expired. CRPA2 - A network error occurred. CRRET - Retry connection. |
| URI | string | false | none | URI for the GET call that will return this connection request. |
| EmailAddresses | UserEmailAddresses | false | none | none |
ConnectionRequestPut
{
"Status": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Status | string | false | none | The status code representing the state of the connection request. The possible values are: CRSUC - The supplier indicated that the connection was made successfully. CREU1 - The loyalty number was not found. CREU2 - The loyalty number doesn't match the name. CREU3 - Your loyalty account requires attention. CRPA1 - The request token has expired. CRPA2 - A network error occurred. CRRET - Retry connection. |
CreateResponse
{
"ID": "string",
"URI": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ID | string | false | none | The unique identifier for the connection request created by this call. |
| URI | string | false | none | URI for the GET call that will return the newly created connection request. |
UserEmailAddresses
{
"Email1": "string",
"Email2": "string",
"Email3": "string",
"Email4": "string",
"Email5": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Email1 | string | false | none | Email address for the user. |
| Email2 | string | false | none | Email address for the user. |
| Email3 | string | false | none | Email address for the user. |
| Email4 | string | false | none | Email address for the user. |
| Email5 | string | false | none | Email address for the user. |
Void
{}
Properties
None
Request Group Configurations v3.1
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Requests allow travelers to submit travel plans, expected expenses, and expected cash advance needs prior to spending funds. Request policies define the required information and workflow for the requests. This API provides the details of the Request policies for the supplied user ID.
Base URLs:
Resources
get__travelrequest_requestgroupconfigurations
Code samples
# You can also use wget
curl -X GET https://us.api.concursolutions.com/api/v3.1/travelrequest/requestgroupconfigurations \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://us.api.concursolutions.com/api/v3.1/travelrequest/requestgroupconfigurations HTTP/1.1
Host: us.api.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://us.api.concursolutions.com/api/v3.1/travelrequest/requestgroupconfigurations',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://us.api.concursolutions.com/api/v3.1/travelrequest/requestgroupconfigurations',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://us.api.concursolutions.com/api/v3.1/travelrequest/requestgroupconfigurations', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://us.api.concursolutions.com/api/v3.1/travelrequest/requestgroupconfigurations', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://us.api.concursolutions.com/api/v3.1/travelrequest/requestgroupconfigurations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://us.api.concursolutions.com/api/v3.1/travelrequest/requestgroupconfigurations", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /travelrequest/requestgroupconfigurations
Get Request group configuration.
Get the Request group configuration owned by the specified user, or all Request group configurations for the company.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| user | query | string | false | The login ID of the user. Optional. The user must have the Web Services Admin (Professional) or Can Administer (Standard) user role to use this parameter. |
| offset | query | string | false | Starting page offset |
| limit | query | integer(int32) | false | Determines the number of records to return (default 10) |
Example responses
200 Response
{
"Items": {
"AgencyOffices": {
"ID": "string",
"Name": "string"
},
"DefaultPolicyID": "string",
"ID": "string",
"Name": "string",
"Policies": {
"HeaderFormID": "string",
"ID": "string",
"IsDefault": true,
"Name": "string",
"NoCreation": true,
"SegmentTypes": {
"DisplayOrder": 0,
"IconCode": "string",
"ID": "string",
"Name": "string",
"SegmentCustomFormID": "string",
"SegmentFormID": "string",
"SegmentTypeCode": "string"
}
},
"RequestTypes": {
"Code": "string",
"Name": "string"
},
"URI": "string"
},
"NextPage": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<RequestGroupConfigurationCollection>
<Items>
<AgencyOffices>
<ID>string</ID>
<Name>string</Name>
</AgencyOffices>
<DefaultPolicyID>string</DefaultPolicyID>
<ID>string</ID>
<Name>string</Name>
<Policies>
<HeaderFormID>string</HeaderFormID>
<ID>string</ID>
<IsDefault>true</IsDefault>
<Name>string</Name>
<NoCreation>true</NoCreation>
<SegmentTypes>
<DisplayOrder>0</DisplayOrder>
<IconCode>string</IconCode>
<ID>string</ID>
<Name>string</Name>
<SegmentCustomFormID>string</SegmentCustomFormID>
<SegmentFormID>string</SegmentFormID>
<SegmentTypeCode>string</SegmentTypeCode>
</SegmentTypes>
</Policies>
<RequestTypes>
<Code>string</Code>
<Name>string</Name>
</RequestTypes>
<URI>string</URI>
</Items>
<NextPage>string</NextPage>
</RequestGroupConfigurationCollection>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | RequestGroupConfigurationCollection |
Schemas
AgencyOffice
{
"ID": "string",
"Name": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ID | string | false | none | The ID of the travel agency office. |
| Name | string | false | none | The travel agency office name. |
Policy
{
"HeaderFormID": "string",
"ID": "string",
"IsDefault": true,
"Name": "string",
"NoCreation": true,
"SegmentTypes": {
"DisplayOrder": 0,
"IconCode": "string",
"ID": "string",
"Name": "string",
"SegmentCustomFormID": "string",
"SegmentFormID": "string",
"SegmentTypeCode": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| HeaderFormID | string | false | none | The unique identifier of the Header Form resource. See the "Forms" resource for more information. |
| ID | string | false | none | The unique identifier of the resource. |
| IsDefault | boolean | false | none | Indicates whether this policy is the default. Format: true or false |
| Name | string | false | none | The name of the policy. |
| NoCreation | boolean | false | none | Indicates whether this policy allows the creation of new Requests by the user. Format: true or false |
| SegmentTypes | SegmentType | false | none | none |
RequestGroupConfiguration
{
"AgencyOffices": {
"ID": "string",
"Name": "string"
},
"DefaultPolicyID": "string",
"ID": "string",
"Name": "string",
"Policies": {
"HeaderFormID": "string",
"ID": "string",
"IsDefault": true,
"Name": "string",
"NoCreation": true,
"SegmentTypes": {
"DisplayOrder": 0,
"IconCode": "string",
"ID": "string",
"Name": "string",
"SegmentCustomFormID": "string",
"SegmentFormID": "string",
"SegmentTypeCode": "string"
}
},
"RequestTypes": {
"Code": "string",
"Name": "string"
},
"URI": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| AgencyOffices | AgencyOffice | false | none | none |
| DefaultPolicyID | string | false | none | The unique identifier of the first policy which allows creation of new Request. |
| ID | string | false | none | The unique identifier of the resource. |
| Name | string | false | none | The name of the Request group Configuration. |
| Policies | Policy | false | none | none |
| RequestTypes | RequestType | false | none | none |
| URI | string | false | none | The URI to the resource. |
RequestGroupConfigurationCollection
{
"Items": {
"AgencyOffices": {
"ID": "string",
"Name": "string"
},
"DefaultPolicyID": "string",
"ID": "string",
"Name": "string",
"Policies": {
"HeaderFormID": "string",
"ID": "string",
"IsDefault": true,
"Name": "string",
"NoCreation": true,
"SegmentTypes": {
"DisplayOrder": 0,
"IconCode": "string",
"ID": "string",
"Name": "string",
"SegmentCustomFormID": "string",
"SegmentFormID": "string",
"SegmentTypeCode": "string"
}
},
"RequestTypes": {
"Code": "string",
"Name": "string"
},
"URI": "string"
},
"NextPage": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Items | RequestGroupConfiguration | false | none | none |
| NextPage | string | false | none | The URI of the next page of results, if any. |
RequestType
{
"Code": "string",
"Name": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Code | string | false | none | The Request type code. |
| Name | string | false | none | The Request type name. |
SegmentType
{
"DisplayOrder": 0,
"IconCode": "string",
"ID": "string",
"Name": "string",
"SegmentCustomFormID": "string",
"SegmentFormID": "string",
"SegmentTypeCode": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| DisplayOrder | integer(int32) | false | none | The display order of the icon associated with the segment type. |
| IconCode | string | false | none | The code for the icon associated with the segment type. |
| ID | string | false | none | The unique identifier of the resource. |
| Name | string | false | none | The name of the segment type. |
| SegmentCustomFormID | string | false | none | The unique identifier of the Segment Form resource which contains custom fields. See the "Forms" resource for more information. |
| SegmentFormID | string | false | none | The unique identifier of the Segment Form resource. See the "Forms" resource for more information. |
| SegmentTypeCode | string | false | none | The code for the type of itinerary segment. |
Version 3.2
Connection Requests v3.2
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Base URLs:
Resources
get__common_connectionrequests
Code samples
# You can also use wget
curl -X GET https://us.api.concursolutions.com/api/v3.2/common/connectionrequests \
-H 'Accept: application/json'
GET https://us.api.concursolutions.com/api/v3.2/common/connectionrequests HTTP/1.1
Host: us.api.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://us.api.concursolutions.com/api/v3.2/common/connectionrequests',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://us.api.concursolutions.com/api/v3.2/common/connectionrequests',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://us.api.concursolutions.com/api/v3.2/common/connectionrequests', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://us.api.concursolutions.com/api/v3.2/common/connectionrequests', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://us.api.concursolutions.com/api/v3.2/common/connectionrequests");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://us.api.concursolutions.com/api/v3.2/common/connectionrequests", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /common/connectionrequests
Get all connection requests
Gets all connection requests that match the TripLink supplier ID.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| offset | query | string | false | The starting point of the next set of results, after the limit specified in the limit field has been reached. The default is the beginning of the page. |
| limit | query | integer(int32) | false | The number of records to return. The default is 5 and the maximum is 10. |
| status | query | string | false | The status code representing the state of the connection request. The possible values are Pending, Processing, Connected, Failed, and Retry. |
Example responses
200 Response
{
"Items": {
"firstName": "string",
"ID": "string",
"lastModified": "string",
"lastName": "string",
"loyaltyNumber": "string",
"middleName": "string",
"requestToken": "string",
"status": "string",
"URI": "string",
"userId": "string",
"emailAddresses": {
"email1": "string",
"email2": "string",
"email3": "string",
"email4": "string",
"email5": "string"
}
},
"NextPage": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ConnectionRequestCollection>
<Items>
<firstName>string</firstName>
<ID>string</ID>
<lastModified>string</lastModified>
<lastName>string</lastName>
<loyaltyNumber>string</loyaltyNumber>
<middleName>string</middleName>
<requestToken>string</requestToken>
<status>string</status>
<URI>string</URI>
<userId>string</userId>
<emailAddresses>
<email1>string</email1>
<email2>string</email2>
<email3>string</email3>
<email4>string</email4>
<email5>string</email5>
</emailAddresses>
</Items>
<NextPage>string</NextPage>
</ConnectionRequestCollection>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ConnectionRequestCollection |
post__common_connectionrequests
Code samples
# You can also use wget
curl -X POST https://us.api.concursolutions.com/api/v3.2/common/connectionrequests?user=string \
-H 'Accept: application/json'
POST https://us.api.concursolutions.com/api/v3.2/common/connectionrequests?user=string HTTP/1.1
Host: us.api.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://us.api.concursolutions.com/api/v3.2/common/connectionrequests?user=string',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.post 'https://us.api.concursolutions.com/api/v3.2/common/connectionrequests',
params: {
'user' => 'string'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.post('https://us.api.concursolutions.com/api/v3.2/common/connectionrequests', params={
'user': 'string'
}, headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://us.api.concursolutions.com/api/v3.2/common/connectionrequests', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://us.api.concursolutions.com/api/v3.2/common/connectionrequests?user=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://us.api.concursolutions.com/api/v3.2/common/connectionrequests", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /common/connectionrequests
Create a connection request
Creates a connection request on behalf of the specified user.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| user | query | string | true | The login ID of the user for whom to create the connection request. The user must have the Web Services Admin role to use this parameter. |
Example responses
200 Response
{
"ID": "string",
"URI": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CreateResponse>
<ID>string</ID>
<URI>string</URI>
</CreateResponse>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | CreateResponse |
get_common_connectionrequests{id}
Code samples
# You can also use wget
curl -X GET https://us.api.concursolutions.com/api/v3.2/common/connectionrequests/{id} \
-H 'Accept: application/json'
GET https://us.api.concursolutions.com/api/v3.2/common/connectionrequests/{id} HTTP/1.1
Host: us.api.concursolutions.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://us.api.concursolutions.com/api/v3.2/common/connectionrequests/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://us.api.concursolutions.com/api/v3.2/common/connectionrequests/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://us.api.concursolutions.com/api/v3.2/common/connectionrequests/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://us.api.concursolutions.com/api/v3.2/common/connectionrequests/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://us.api.concursolutions.com/api/v3.2/common/connectionrequests/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://us.api.concursolutions.com/api/v3.2/common/connectionrequests/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /common/connectionrequests/{id}
Get a connection request by ID
Gets a connection request by ID.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The connection request ID. |
Example responses
200 Response
{
"firstName": "string",
"ID": "string",
"lastModified": "string",
"lastName": "string",
"loyaltyNumber": "string",
"middleName": "string",
"requestToken": "string",
"status": "string",
"URI": "string",
"userId": "string",
"emailAddresses": {
"email1": "string",
"email2": "string",
"email3": "string",
"email4": "string",
"email5": "string"
}
}
<?xml version="1.0" encoding="UTF-8" ?>
<ConnectionRequestGet>
<firstName>string</firstName>
<ID>string</ID>
<lastModified>string</lastModified>
<lastName>string</lastName>
<loyaltyNumber>string</loyaltyNumber>
<middleName>string</middleName>
<requestToken>string</requestToken>
<status>string</status>
<URI>string</URI>
<userId>string</userId>
<emailAddresses>
<email1>string</email1>
<email2>string</email2>
<email3>string</email3>
<email4>string</email4>
<email5>string</email5>
</emailAddresses>
</ConnectionRequestGet>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ConnectionRequestGet |
put_common_connectionrequests{id}
Code samples
# You can also use wget
curl -X PUT https://us.api.concursolutions.com/api/v3.2/common/connectionrequests/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
PUT https://us.api.concursolutions.com/api/v3.2/common/connectionrequests/{id} HTTP/1.1
Host: us.api.concursolutions.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"status": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://us.api.concursolutions.com/api/v3.2/common/connectionrequests/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.put 'https://us.api.concursolutions.com/api/v3.2/common/connectionrequests/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.put('https://us.api.concursolutions.com/api/v3.2/common/connectionrequests/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','https://us.api.concursolutions.com/api/v3.2/common/connectionrequests/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://us.api.concursolutions.com/api/v3.2/common/connectionrequests/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://us.api.concursolutions.com/api/v3.2/common/connectionrequests/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /common/connectionrequests/{id}
Update a connection request by ID
Updates the specified connection request. Only the fields provided in the supplied object are updated. Missing fields will not be altered.
Body parameter
{
"status": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ConnectionRequestPut>
<status>string</status>
</ConnectionRequestPut>
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The connection request ID. |
| body | body | ConnectionRequestPut | true | The connection request object to update. |
Example responses
200 Response
{}
<?xml version="1.0" encoding="UTF-8" ?>
<Void/>
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Void |
Schemas
ConnectionRequestCollection
{
"Items": {
"firstName": "string",
"ID": "string",
"lastModified": "string",
"lastName": "string",
"loyaltyNumber": "string",
"middleName": "string",
"requestToken": "string",
"status": "string",
"URI": "string",
"userId": "string",
"emailAddresses": {
"email1": "string",
"email2": "string",
"email3": "string",
"email4": "string",
"email5": "string"
}
},
"NextPage": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Items | ConnectionRequestGet | false | none | none |
| NextPage | string | false | none | If provided, the URI for the next GET call. |
ConnectionRequestGet
{
"firstName": "string",
"ID": "string",
"lastModified": "string",
"lastName": "string",
"loyaltyNumber": "string",
"middleName": "string",
"requestToken": "string",
"status": "string",
"URI": "string",
"userId": "string",
"emailAddresses": {
"email1": "string",
"email2": "string",
"email3": "string",
"email4": "string",
"email5": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| firstName | string | false | none | first name of the user for whom the connection request is for. |
| ID | string | false | none | The unique identifier for the connection request. |
| lastModified | string | false | none | The UTC date representing when this connection rerquest was last modified. Format: YYY-MM-DDTHH:MM:SS |
| lastName | string | false | none | The last name of the user for whom the connection request is for. |
| loyaltyNumber | string | false | none | The user's loyalty number. |
| middleName | string | false | none | The middle name of the user for whom the connection request is for. |
| requestToken | string | false | none | OAuth2 request token with a limited lifetime (15 minutes) that may be exchanged for an access token. |
| status | string | false | none | The status code representing the state of the connection request. The possible values are: CRSUC - The supplier indicated that the connection was made successfully. CREU1 - The loyalty number was not found. CREU2 - The loyalty number doesn't match the name. CREU3 - Your loyalty account requires attention. CRPA1 - The request token has expired. CRPA2 - A network error occurred. CRRET - Retry connection. |
| URI | string | false | none | URI for the GET call that will return this connection request. |
| userId | string | false | none | The unique identifier for the user. |
| emailAddresses | UserEmailAddresses | false | none | none |
ConnectionRequestPut
{
"status": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| status | string | false | none | The status code representing the state of the connection request. The possible values are: CRSUC - The supplier indicated that the connection was made successfully. CREU1 - The loyalty number was not found. CREU2 - The loyalty number doesn't match the name. CREU3 - Your loyalty account requires attention. CRPA1 - The request token has expired. CRPA2 - A network error occurred. CRRET - Retry connection. |
CreateResponse
{
"ID": "string",
"URI": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ID | string | false | none | The unique identifier for the connection request created by this call. |
| URI | string | false | none | URI for the GET call that will return the newly created connection request. |
UserEmailAddresses
{
"email1": "string",
"email2": "string",
"email3": "string",
"email4": "string",
"email5": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| email1 | string | false | none | Email address for the user. |
| email2 | string | false | none | Email address for the user. |
| email3 | string | false | none | Email address for the user. |
| email4 | string | false | none | Email address for the user. |
| email5 | string | false | none | Email address for the user. |
Void
{}
Properties
None
Version 4.0
Budget v4.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
The Budget service exposes budget and fiscal year data. Partners and clients may use the service endpoints to read and alter fiscal year, budget, budget adjustment, and budget matching configuration. Summary and detailed balance amounts are also available to read, but may not be altered via the API.
Base URLs:
Budget Adjustments
Object defines the adjustments made to a budget header
saveAdjustmentsUsingPOST
Code samples
# You can also use wget
curl -X POST /www.concursolutions.com/budget/v4/adjustments?useMonthlyRollingUpdate=true \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
POST /www.concursolutions.com/budget/v4/adjustments?useMonthlyRollingUpdate=true HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '[
{
"adjustmentType": "BUDGET_BALANCE",
"amount": 500,
"amountType": "BUDGET_AMOUNT",
"budgetItemName": "Marketing",
"budgetOwnerEmail": "name@compamy.com",
"description": "Sample description",
"fiscalPeriodName": "2018 - Q3",
"fiscalYearName": 2018,
"transactionDate": "2018-07-11"
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('/www.concursolutions.com/budget/v4/adjustments?useMonthlyRollingUpdate=true',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post '/www.concursolutions.com/budget/v4/adjustments',
params: {
'useMonthlyRollingUpdate' => 'boolean'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('/www.concursolutions.com/budget/v4/adjustments', params={
'useMonthlyRollingUpdate': 'true'
}, headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/www.concursolutions.com/budget/v4/adjustments', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/www.concursolutions.com/budget/v4/adjustments?useMonthlyRollingUpdate=true");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/www.concursolutions.com/budget/v4/adjustments", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /budget/v4/adjustments
Saves a list of adjustments
Body parameter
[
{
"adjustmentType": "BUDGET_BALANCE",
"amount": 500,
"amountType": "BUDGET_AMOUNT",
"budgetItemName": "Marketing",
"budgetOwnerEmail": "name@compamy.com",
"description": "Sample description",
"fiscalPeriodName": "2018 - Q3",
"fiscalYearName": 2018,
"transactionDate": "2018-07-11"
}
]
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| useMonthlyRollingUpdate | query | boolean | true | Should roll adjustments for months. If true, only one record will be maintained for a budget detail for every amount type for a given month |
| body | body | BudgetAdjustmentsExternal | false | The adjustments to save |
Example responses
200 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | string |
| 201 | Created | Created | None |
| 400 | Bad Request | Invalid request | None |
| 401 | Unauthorized | Unauthorized | None |
| 403 | Forbidden | Forbidden | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal error | None |
Budget Category
Groups of expense types
getBudgetCategoryByEntityIdUsingGET
Code samples
# You can also use wget
curl -X GET /www.concursolutions.com/budget/v4/budgetCategory \
-H 'Accept: application/json'
GET /www.concursolutions.com/budget/v4/budgetCategory HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('/www.concursolutions.com/budget/v4/budgetCategory',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get '/www.concursolutions.com/budget/v4/budgetCategory',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('/www.concursolutions.com/budget/v4/budgetCategory', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/www.concursolutions.com/budget/v4/budgetCategory', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/www.concursolutions.com/budget/v4/budgetCategory");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/www.concursolutions.com/budget/v4/budgetCategory", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /budget/v4/budgetCategory
Fetches all of the budget categories in the system for an entity.
Example responses
200 Response
[
{
"description": "string",
"expenseTypes": [
{
"expenseTypeCode": "string",
"featureTypeCode": "REQUEST",
"id": "string",
"name": "string",
"syncGuid": "string"
}
],
"id": "string",
"name": "string",
"statusType": "OPEN",
"syncGuid": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Inline |
| 400 | Bad Request | Invalid request | None |
| 401 | Unauthorized | Unauthorized | None |
| 403 | Forbidden | Forbidden | None |
| 404 | Not Found | Not found | None |
| 500 | Internal Server Error | Internal error | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [BudgetCategory] | false | none | none |
| » description | string | false | none | none |
| » expenseTypes | [ExpenseType] | true | none | The list of expense types that this budget category matches. |
| »» expenseTypeCode | string | false | none | The alphanumeric code that describes an expense type. Ex: TRAVEL, AC_CATER Any string may be used, but only expense type codes returned by GET /budgetCategory/expenseType will behave properly in the Concur UI. |
| »» featureTypeCode | string | false | none | The type of feature that this expense type applies to, Purchase Request, Payment Request (Invoice), Expense or Travel Authorization |
| »» id | string | false | none | The unique idenifier for the expense type |
| »» name | string | true | none | none |
| »» syncGuid | string | false | none | The unique idenifier for the expense type |
| » id | string | false | none | The unique identifier for the budget category. |
| » name | string | true | none | The name of this budget category. |
| » statusType | string | false | none | The status of this budget category--only open and removed are meaningful for budget category. |
| » syncGuid | string | false | none | The unique identifier for the budget category. |
Enumerated Values
| Property | Value |
|---|---|
| featureTypeCode | REQUEST |
| featureTypeCode | TRAVEL |
| featureTypeCode | EXPENSE |
| featureTypeCode | PAYMENT_REQUEST |
| featureTypeCode | PURCHASE_REQUEST |
| featureTypeCode | ADJUSTMENT |
| featureTypeCode | EMPLOYEE |
| statusType | OPEN |
| statusType | CLOSED |
| statusType | REMOVED |
| statusType | MERGED |
saveBudgetCategoryUsingPOST
Code samples
# You can also use wget
curl -X POST /www.concursolutions.com/budget/v4/budgetCategory \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
POST /www.concursolutions.com/budget/v4/budgetCategory HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"description": "string",
"expenseTypes": [
{
"expenseTypeCode": "string",
"featureTypeCode": "REQUEST",
"id": "string",
"name": "string",
"syncGuid": "string"
}
],
"id": "string",
"name": "string",
"statusType": "OPEN",
"syncGuid": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('/www.concursolutions.com/budget/v4/budgetCategory',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post '/www.concursolutions.com/budget/v4/budgetCategory',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('/www.concursolutions.com/budget/v4/budgetCategory', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/www.concursolutions.com/budget/v4/budgetCategory', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/www.concursolutions.com/budget/v4/budgetCategory");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/www.concursolutions.com/budget/v4/budgetCategory", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /budget/v4/budgetCategory
Save budget category. Creates a new budget category if one doesn't exist.
Body parameter
{
"description": "string",
"expenseTypes": [
{
"expenseTypeCode": "string",
"featureTypeCode": "REQUEST",
"id": "string",
"name": "string",
"syncGuid": "string"
}
],
"id": "string",
"name": "string",
"statusType": "OPEN",
"syncGuid": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | BudgetCategory | true | budgetCategory |
Example responses
200 Response
{
"description": "string",
"expenseTypes": [
{
"expenseTypeCode": "string",
"featureTypeCode": "REQUEST",
"id": "string",
"name": "string",
"syncGuid": "string"
}
],
"id": "string",
"name": "string",
"statusType": "OPEN",
"syncGuid": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | BudgetCategory |
| 201 | Created | Created | None |
| 400 | Bad Request | Invalid request | None |
| 401 | Unauthorized | Unauthorized | None |
| 403 | Forbidden | Forbidden | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal error | None |
getExpenseTypesUsingGET
Code samples
# You can also use wget
curl -X GET /www.concursolutions.com/budget/v4/budgetCategory/expenseTypes \
-H 'Accept: application/json'
GET /www.concursolutions.com/budget/v4/budgetCategory/expenseTypes HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('/www.concursolutions.com/budget/v4/budgetCategory/expenseTypes',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get '/www.concursolutions.com/budget/v4/budgetCategory/expenseTypes',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('/www.concursolutions.com/budget/v4/budgetCategory/expenseTypes', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/www.concursolutions.com/budget/v4/budgetCategory/expenseTypes', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/www.concursolutions.com/budget/v4/budgetCategory/expenseTypes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/www.concursolutions.com/budget/v4/budgetCategory/expenseTypes", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /budget/v4/budgetCategory/expenseTypes
Calls the concur midtier to fetches the list of expense types for the given entity.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| userLanguage | query | string | false | userLanguage |
Example responses
200 Response
[
{
"expenseTypeCode": "string",
"featureTypeCode": "REQUEST",
"id": "string",
"name": "string",
"syncGuid": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Inline |
| 400 | Bad Request | Invalid request | None |
| 401 | Unauthorized | Unauthorized | None |
| 403 | Forbidden | Forbidden | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal error | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [ExpenseType] | false | none | none |
| » expenseTypeCode | string | false | none | The alphanumeric code that describes an expense type. Ex: TRAVEL, AC_CATER Any string may be used, but only expense type codes returned by GET /budgetCategory/expenseType will behave properly in the Concur UI. |
| » featureTypeCode | string | false | none | The type of feature that this expense type applies to, Purchase Request, Payment Request (Invoice), Expense or Travel Authorization |
| » id | string | false | none | The unique idenifier for the expense type |
| » name | string | true | none | none |
| » syncGuid | string | false | none | The unique idenifier for the expense type |
Enumerated Values
| Property | Value |
|---|---|
| featureTypeCode | REQUEST |
| featureTypeCode | TRAVEL |
| featureTypeCode | EXPENSE |
| featureTypeCode | PAYMENT_REQUEST |
| featureTypeCode | PURCHASE_REQUEST |
| featureTypeCode | ADJUSTMENT |
| featureTypeCode | EMPLOYEE |
getBudgetCategoryUsingGET
Code samples
# You can also use wget
curl -X GET /www.concursolutions.com/budget/v4/budgetCategory/{id} \
-H 'Accept: application/json'
GET /www.concursolutions.com/budget/v4/budgetCategory/{id} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('/www.concursolutions.com/budget/v4/budgetCategory/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get '/www.concursolutions.com/budget/v4/budgetCategory/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('/www.concursolutions.com/budget/v4/budgetCategory/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/www.concursolutions.com/budget/v4/budgetCategory/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/www.concursolutions.com/budget/v4/budgetCategory/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/www.concursolutions.com/budget/v4/budgetCategory/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /budget/v4/budgetCategory/{id}
Fetches an individual budget category by the guid.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Budget category guid |
Example responses
200 Response
{
"description": "string",
"expenseTypes": [
{
"expenseTypeCode": "string",
"featureTypeCode": "REQUEST",
"id": "string",
"name": "string",
"syncGuid": "string"
}
],
"id": "string",
"name": "string",
"statusType": "OPEN",
"syncGuid": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | BudgetCategory |
| 400 | Bad Request | Invalid request | None |
| 401 | Unauthorized | Unauthorized | None |
| 403 | Forbidden | Forbidden | None |
| 404 | Not Found | Not found | None |
| 500 | Internal Server Error | Internal error | None |
deleteBudgetCategoryUsingDELETE
Code samples
# You can also use wget
curl -X DELETE /www.concursolutions.com/budget/v4/budgetCategory/{id} \
-H 'Accept: application/json'
DELETE /www.concursolutions.com/budget/v4/budgetCategory/{id} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('/www.concursolutions.com/budget/v4/budgetCategory/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.delete '/www.concursolutions.com/budget/v4/budgetCategory/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.delete('/www.concursolutions.com/budget/v4/budgetCategory/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/www.concursolutions.com/budget/v4/budgetCategory/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/www.concursolutions.com/budget/v4/budgetCategory/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/www.concursolutions.com/budget/v4/budgetCategory/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /budget/v4/budgetCategory/{id}
Remove budget category by sync guid.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Budget category guid |
Example responses
200 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | string |
| 204 | No Content | No Content | None |
| 400 | Bad Request | Invalid request | None |
| 401 | Unauthorized | Unauthorized | None |
| 403 | Forbidden | Forbidden | None |
| 404 | Not Found | Not found | None |
| 500 | Internal Server Error | Internal error | None |
Budget Item
Budget Item Controller
searchBudgetItemsPagedUsingGET
Code samples
# You can also use wget
curl -X GET /www.concursolutions.com/budget/v4/budgetItemHeader \
-H 'Accept: application/json'
GET /www.concursolutions.com/budget/v4/budgetItemHeader HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('/www.concursolutions.com/budget/v4/budgetItemHeader',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get '/www.concursolutions.com/budget/v4/budgetItemHeader',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('/www.concursolutions.com/budget/v4/budgetItemHeader', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/www.concursolutions.com/budget/v4/budgetItemHeader', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/www.concursolutions.com/budget/v4/budgetItemHeader");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/www.concursolutions.com/budget/v4/budgetItemHeader", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /budget/v4/budgetItemHeader
Fetch all budget items for an entity.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| adminView | query | boolean | false | Response is needed for administration purpose |
| offset | query | integer(int32) | false | Offset based pagination |
Example responses
200 Response
{
"budgetItemHeaders": [
{
"active": true,
"annualBudget": 0,
"budgetAmounts": {
"adjustedBudgetAmount": 0,
"availableAmount": 0,
"consumedPercent": 0,
"pendingAmount": 0,
"spendAmount": 0,
"threshold": "UNDER",
"unExpensedAmount": 0,
"unExpensedSettings": true
},
"budgetApprovers": [
{
"email": "string",
"employeeId": "string",
"employeeUuid": "string",
"externalUserCUUID": "string",
"externalUserSyncGuid": "string",
"id": "string",
"name": "string",
"syncGuid": "string"
}
],
"budgetCategory": {
"description": "string",
"expenseTypes": [
{
"expenseTypeCode": "string",
"featureTypeCode": "REQUEST",
"id": "string",
"name": "string",
"syncGuid": "string"
}
],
"id": "string",
"name": "string",
"statusType": "OPEN",
"syncGuid": "string"
},
"budgetItemDetails": [
{
"amount": 0,
"budgetAmounts": {
"adjustedBudgetAmount": 0,
"availableAmount": 0,
"consumedPercent": 0,
"pendingAmount": 0,
"spendAmount": 0,
"threshold": "UNDER",
"unExpensedAmount": 0,
"unExpensedSettings": true
},
"budgetItemBalances": [
{
"amount": 0,
"featureTypeCode": "REQUEST",
"featureTypeSubCode": "QUICK_EXPENSE",
"id": "string",
"syncGuid": "string",
"workflowState": "NONE"
}
],
"budgetItemDetailStatusType": "OPEN",
"budgetItemHeaderId": "string",
"budgetItemHeaderSyncGuid": "string",
"budgetName": "string",
"currencyCode": "string",
"detailDashboardBudgetItemAdjustments": [
{
"adjustedBy": "string",
"adjustmentType": "BUDGET_BALANCE",
"amount": 0,
"amountType": "QUICK_EXPENSE",
"description": "string",
"transactionDate": "2019-08-24"
}
],
"fiscalPeriod": {
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
},
"fiscalPeriodId": "string",
"id": "string",
"syncGuid": "string"
}
],
"budgetItemStatusType": "OPEN",
"budgetManagers": [
{
"email": "string",
"employeeId": "string",
"employeeUuid": "string",
"externalUserCUUID": "string",
"externalUserSyncGuid": "string",
"id": "string",
"name": "string",
"syncGuid": "string"
}
],
"budgetType": "PERSONAL_USE",
"budgetViewers": [
{
"email": "string",
"employeeId": "string",
"employeeUuid": "string",
"externalUserCUUID": "string",
"externalUserSyncGuid": "string",
"id": "string",
"name": "string",
"syncGuid": "string"
}
],
"costObjects": [
{
"code": "string",
"displayName": "string",
"fieldDefinitionId": "string",
"listKey": "string",
"listName": "string",
"operator": "EQUAL",
"value": "string"
}
],
"createdDate": "2019-08-24T14:15:22Z",
"currencyCode": "string",
"dateRange": {
"endDate": "2019-08-24",
"startDate": "2019-08-24"
},
"description": "string",
"fiscalYear": {
"currentYear": true,
"customFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"displayName": "string",
"endDate": "2019-08-24",
"fiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"id": "string",
"lastModified": "2019-08-24T14:15:22Z",
"monthlyFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"name": "string",
"openAndClosedFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"quarterlyFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"startDate": "2019-08-24",
"status": "OPEN",
"syncGuid": "string",
"yearlyFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
]
},
"fiscalYearId": "string",
"id": "string",
"isTest": true,
"lastModifiedDate": "2019-08-24T14:15:22Z",
"name": "string",
"owned": true,
"owner": {
"email": "string",
"employeeId": "string",
"employeeUuid": "string",
"externalUserCUUID": "string",
"externalUserSyncGuid": "string",
"id": "string",
"name": "string",
"syncGuid": "string"
},
"periodType": "MONTHLY",
"syncGuid": "string",
"test": true
}
],
"href": "string",
"limit": 0,
"next": {
"href": "string"
},
"offset": 0,
"previous": {
"href": "string"
},
"totalRows": 0
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | PagedBudgetItemHeaderResult |
| 400 | Bad Request | Invalid request | None |
| 401 | Unauthorized | Unauthorized | None |
| 403 | Forbidden | Forbidden | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | InternalError | None |
saveBudgetItemUsingPOST
Code samples
# You can also use wget
curl -X POST /www.concursolutions.com/budget/v4/budgetItemHeader \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
POST /www.concursolutions.com/budget/v4/budgetItemHeader HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"active": true,
"annualBudget": 0,
"budgetAmounts": {
"adjustedBudgetAmount": 0,
"availableAmount": 0,
"consumedPercent": 0,
"pendingAmount": 0,
"spendAmount": 0,
"threshold": "UNDER",
"unExpensedAmount": 0,
"unExpensedSettings": true
},
"budgetApprovers": [
{
"email": "string",
"employeeId": "string",
"employeeUuid": "string",
"externalUserCUUID": "string",
"externalUserSyncGuid": "string",
"id": "string",
"name": "string",
"syncGuid": "string"
}
],
"budgetCategory": {
"description": "string",
"expenseTypes": [
{
"expenseTypeCode": "string",
"featureTypeCode": "REQUEST",
"id": "string",
"name": "string",
"syncGuid": "string"
}
],
"id": "string",
"name": "string",
"statusType": "OPEN",
"syncGuid": "string"
},
"budgetItemDetails": [
{
"amount": 0,
"budgetAmounts": {
"adjustedBudgetAmount": 0,
"availableAmount": 0,
"consumedPercent": 0,
"pendingAmount": 0,
"spendAmount": 0,
"threshold": "UNDER",
"unExpensedAmount": 0,
"unExpensedSettings": true
},
"budgetItemBalances": [
{
"amount": 0,
"featureTypeCode": "REQUEST",
"featureTypeSubCode": "QUICK_EXPENSE",
"id": "string",
"syncGuid": "string",
"workflowState": "NONE"
}
],
"budgetItemDetailStatusType": "OPEN",
"budgetItemHeaderId": "string",
"budgetItemHeaderSyncGuid": "string",
"budgetName": "string",
"currencyCode": "string",
"detailDashboardBudgetItemAdjustments": [
{
"adjustedBy": "string",
"adjustmentType": "BUDGET_BALANCE",
"amount": 0,
"amountType": "QUICK_EXPENSE",
"description": "string",
"transactionDate": "2019-08-24"
}
],
"fiscalPeriod": {
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
},
"fiscalPeriodId": "string",
"id": "string",
"syncGuid": "string"
}
],
"budgetItemStatusType": "OPEN",
"budgetManagers": [
{
"email": "string",
"employeeId": "string",
"employeeUuid": "string",
"externalUserCUUID": "string",
"externalUserSyncGuid": "string",
"id": "string",
"name": "string",
"syncGuid": "string"
}
],
"budgetType": "PERSONAL_USE",
"budgetViewers": [
{
"email": "string",
"employeeId": "string",
"employeeUuid": "string",
"externalUserCUUID": "string",
"externalUserSyncGuid": "string",
"id": "string",
"name": "string",
"syncGuid": "string"
}
],
"costObjects": [
{
"code": "string",
"displayName": "string",
"fieldDefinitionId": "string",
"listKey": "string",
"listName": "string",
"operator": "EQUAL",
"value": "string"
}
],
"createdDate": "2019-08-24T14:15:22Z",
"currencyCode": "string",
"dateRange": {
"endDate": "2019-08-24",
"startDate": "2019-08-24"
},
"description": "string",
"fiscalYear": {
"currentYear": true,
"customFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"displayName": "string",
"endDate": "2019-08-24",
"fiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"id": "string",
"lastModified": "2019-08-24T14:15:22Z",
"monthlyFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"name": "string",
"openAndClosedFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"quarterlyFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"startDate": "2019-08-24",
"status": "OPEN",
"syncGuid": "string",
"yearlyFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
]
},
"fiscalYearId": "string",
"id": "string",
"isTest": true,
"lastModifiedDate": "2019-08-24T14:15:22Z",
"name": "string",
"owned": true,
"owner": {
"email": "string",
"employeeId": "string",
"employeeUuid": "string",
"externalUserCUUID": "string",
"externalUserSyncGuid": "string",
"id": "string",
"name": "string",
"syncGuid": "string"
},
"periodType": "MONTHLY",
"syncGuid": "string",
"test": true
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('/www.concursolutions.com/budget/v4/budgetItemHeader',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post '/www.concursolutions.com/budget/v4/budgetItemHeader',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('/www.concursolutions.com/budget/v4/budgetItemHeader', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/www.concursolutions.com/budget/v4/budgetItemHeader', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/www.concursolutions.com/budget/v4/budgetItemHeader");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/www.concursolutions.com/budget/v4/budgetItemHeader", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /budget/v4/budgetItemHeader
Save budget item. Creates a new budget item if one doesn't exist.
Body parameter
{
"active": true,
"annualBudget": 0,
"budgetAmounts": {
"adjustedBudgetAmount": 0,
"availableAmount": 0,
"consumedPercent": 0,
"pendingAmount": 0,
"spendAmount": 0,
"threshold": "UNDER",
"unExpensedAmount": 0,
"unExpensedSettings": true
},
"budgetApprovers": [
{
"email": "string",
"employeeId": "string",
"employeeUuid": "string",
"externalUserCUUID": "string",
"externalUserSyncGuid": "string",
"id": "string",
"name": "string",
"syncGuid": "string"
}
],
"budgetCategory": {
"description": "string",
"expenseTypes": [
{
"expenseTypeCode": "string",
"featureTypeCode": "REQUEST",
"id": "string",
"name": "string",
"syncGuid": "string"
}
],
"id": "string",
"name": "string",
"statusType": "OPEN",
"syncGuid": "string"
},
"budgetItemDetails": [
{
"amount": 0,
"budgetAmounts": {
"adjustedBudgetAmount": 0,
"availableAmount": 0,
"consumedPercent": 0,
"pendingAmount": 0,
"spendAmount": 0,
"threshold": "UNDER",
"unExpensedAmount": 0,
"unExpensedSettings": true
},
"budgetItemBalances": [
{
"amount": 0,
"featureTypeCode": "REQUEST",
"featureTypeSubCode": "QUICK_EXPENSE",
"id": "string",
"syncGuid": "string",
"workflowState": "NONE"
}
],
"budgetItemDetailStatusType": "OPEN",
"budgetItemHeaderId": "string",
"budgetItemHeaderSyncGuid": "string",
"budgetName": "string",
"currencyCode": "string",
"detailDashboardBudgetItemAdjustments": [
{
"adjustedBy": "string",
"adjustmentType": "BUDGET_BALANCE",
"amount": 0,
"amountType": "QUICK_EXPENSE",
"description": "string",
"transactionDate": "2019-08-24"
}
],
"fiscalPeriod": {
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
},
"fiscalPeriodId": "string",
"id": "string",
"syncGuid": "string"
}
],
"budgetItemStatusType": "OPEN",
"budgetManagers": [
{
"email": "string",
"employeeId": "string",
"employeeUuid": "string",
"externalUserCUUID": "string",
"externalUserSyncGuid": "string",
"id": "string",
"name": "string",
"syncGuid": "string"
}
],
"budgetType": "PERSONAL_USE",
"budgetViewers": [
{
"email": "string",
"employeeId": "string",
"employeeUuid": "string",
"externalUserCUUID": "string",
"externalUserSyncGuid": "string",
"id": "string",
"name": "string",
"syncGuid": "string"
}
],
"costObjects": [
{
"code": "string",
"displayName": "string",
"fieldDefinitionId": "string",
"listKey": "string",
"listName": "string",
"operator": "EQUAL",
"value": "string"
}
],
"createdDate": "2019-08-24T14:15:22Z",
"currencyCode": "string",
"dateRange": {
"endDate": "2019-08-24",
"startDate": "2019-08-24"
},
"description": "string",
"fiscalYear": {
"currentYear": true,
"customFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"displayName": "string",
"endDate": "2019-08-24",
"fiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"id": "string",
"lastModified": "2019-08-24T14:15:22Z",
"monthlyFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"name": "string",
"openAndClosedFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"quarterlyFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"startDate": "2019-08-24",
"status": "OPEN",
"syncGuid": "string",
"yearlyFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
]
},
"fiscalYearId": "string",
"id": "string",
"isTest": true,
"lastModifiedDate": "2019-08-24T14:15:22Z",
"name": "string",
"owned": true,
"owner": {
"email": "string",
"employeeId": "string",
"employeeUuid": "string",
"externalUserCUUID": "string",
"externalUserSyncGuid": "string",
"id": "string",
"name": "string",
"syncGuid": "string"
},
"periodType": "MONTHLY",
"syncGuid": "string",
"test": true
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | BudgetItemHeader | true | budgetItemHeader |
Example responses
200 Response
{
"budgetItemHeaderSyncGuid": "string",
"success": true
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | BudgetItemHeaderResponse |
| 201 | Created | Created | None |
| 400 | Bad Request | Invalid request | None |
| 401 | Unauthorized | Unauthorized | None |
| 403 | Forbidden | Forbidden | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal error | None |
getBudgetItemV4UsingGET
Code samples
# You can also use wget
curl -X GET /www.concursolutions.com/budget/v4/budgetItemHeader/{id} \
-H 'Accept: application/json'
GET /www.concursolutions.com/budget/v4/budgetItemHeader/{id} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('/www.concursolutions.com/budget/v4/budgetItemHeader/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get '/www.concursolutions.com/budget/v4/budgetItemHeader/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('/www.concursolutions.com/budget/v4/budgetItemHeader/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/www.concursolutions.com/budget/v4/budgetItemHeader/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/www.concursolutions.com/budget/v4/budgetItemHeader/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/www.concursolutions.com/budget/v4/budgetItemHeader/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /budget/v4/budgetItemHeader/{id}
Fetches a budget item by guid.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Budget item guid |
Example responses
200 Response
{
"active": true,
"annualBudget": 0,
"budgetAmounts": {
"adjustedBudgetAmount": 0,
"availableAmount": 0,
"consumedPercent": 0,
"pendingAmount": 0,
"spendAmount": 0,
"threshold": "UNDER",
"unExpensedAmount": 0,
"unExpensedSettings": true
},
"budgetApprovers": [
{
"email": "string",
"employeeId": "string",
"employeeUuid": "string",
"externalUserCUUID": "string",
"externalUserSyncGuid": "string",
"id": "string",
"name": "string",
"syncGuid": "string"
}
],
"budgetCategory": {
"description": "string",
"expenseTypes": [
{
"expenseTypeCode": "string",
"featureTypeCode": "REQUEST",
"id": "string",
"name": "string",
"syncGuid": "string"
}
],
"id": "string",
"name": "string",
"statusType": "OPEN",
"syncGuid": "string"
},
"budgetItemDetails": [
{
"amount": 0,
"budgetAmounts": {
"adjustedBudgetAmount": 0,
"availableAmount": 0,
"consumedPercent": 0,
"pendingAmount": 0,
"spendAmount": 0,
"threshold": "UNDER",
"unExpensedAmount": 0,
"unExpensedSettings": true
},
"budgetItemBalances": [
{
"amount": 0,
"featureTypeCode": "REQUEST",
"featureTypeSubCode": "QUICK_EXPENSE",
"id": "string",
"syncGuid": "string",
"workflowState": "NONE"
}
],
"budgetItemDetailStatusType": "OPEN",
"budgetItemHeaderId": "string",
"budgetItemHeaderSyncGuid": "string",
"budgetName": "string",
"currencyCode": "string",
"detailDashboardBudgetItemAdjustments": [
{
"adjustedBy": "string",
"adjustmentType": "BUDGET_BALANCE",
"amount": 0,
"amountType": "QUICK_EXPENSE",
"description": "string",
"transactionDate": "2019-08-24"
}
],
"fiscalPeriod": {
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
},
"fiscalPeriodId": "string",
"id": "string",
"syncGuid": "string"
}
],
"budgetItemStatusType": "OPEN",
"budgetManagers": [
{
"email": "string",
"employeeId": "string",
"employeeUuid": "string",
"externalUserCUUID": "string",
"externalUserSyncGuid": "string",
"id": "string",
"name": "string",
"syncGuid": "string"
}
],
"budgetType": "PERSONAL_USE",
"budgetViewers": [
{
"email": "string",
"employeeId": "string",
"employeeUuid": "string",
"externalUserCUUID": "string",
"externalUserSyncGuid": "string",
"id": "string",
"name": "string",
"syncGuid": "string"
}
],
"costObjects": [
{
"code": "string",
"displayName": "string",
"fieldDefinitionId": "string",
"listKey": "string",
"listName": "string",
"operator": "EQUAL",
"value": "string"
}
],
"createdDate": "2019-08-24T14:15:22Z",
"currencyCode": "string",
"dateRange": {
"endDate": "2019-08-24",
"startDate": "2019-08-24"
},
"description": "string",
"fiscalYear": {
"currentYear": true,
"customFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"displayName": "string",
"endDate": "2019-08-24",
"fiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"id": "string",
"lastModified": "2019-08-24T14:15:22Z",
"monthlyFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"name": "string",
"openAndClosedFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"quarterlyFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"startDate": "2019-08-24",
"status": "OPEN",
"syncGuid": "string",
"yearlyFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
]
},
"fiscalYearId": "string",
"id": "string",
"isTest": true,
"lastModifiedDate": "2019-08-24T14:15:22Z",
"name": "string",
"owned": true,
"owner": {
"email": "string",
"employeeId": "string",
"employeeUuid": "string",
"externalUserCUUID": "string",
"externalUserSyncGuid": "string",
"id": "string",
"name": "string",
"syncGuid": "string"
},
"periodType": "MONTHLY",
"syncGuid": "string",
"test": true
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | BudgetItemHeader |
| 400 | Bad Request | Invalid request | None |
| 401 | Unauthorized | Unauthorized | None |
| 403 | Forbidden | Forbidden | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal error | None |
removeBudgetItemUsingDELETE
Code samples
# You can also use wget
curl -X DELETE /www.concursolutions.com/budget/v4/budgetItemHeader/{id} \
-H 'Accept: application/json'
DELETE /www.concursolutions.com/budget/v4/budgetItemHeader/{id} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('/www.concursolutions.com/budget/v4/budgetItemHeader/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.delete '/www.concursolutions.com/budget/v4/budgetItemHeader/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.delete('/www.concursolutions.com/budget/v4/budgetItemHeader/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/www.concursolutions.com/budget/v4/budgetItemHeader/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/www.concursolutions.com/budget/v4/budgetItemHeader/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/www.concursolutions.com/budget/v4/budgetItemHeader/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /budget/v4/budgetItemHeader/{id}
Remove budget item
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Budget item guid |
Example responses
200 Response
{
"budgetItemHeaderSyncGuid": "string",
"success": true
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | BudgetItemHeaderResponse |
| 204 | No Content | No Content | None |
| 400 | Bad Request | Invalid request | None |
| 401 | Unauthorized | Unauthorized | None |
| 403 | Forbidden | Forbidden | None |
| 500 | Internal Server Error | Internal error | None |
deleteBudgetItemUsingDELETE
Code samples
# You can also use wget
curl -X DELETE /www.concursolutions.com/budget/v4/delete/budgetItemHeader/{syncGuid} \
-H 'Accept: application/json'
DELETE /www.concursolutions.com/budget/v4/delete/budgetItemHeader/{syncGuid} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('/www.concursolutions.com/budget/v4/delete/budgetItemHeader/{syncGuid}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.delete '/www.concursolutions.com/budget/v4/delete/budgetItemHeader/{syncGuid}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.delete('/www.concursolutions.com/budget/v4/delete/budgetItemHeader/{syncGuid}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/www.concursolutions.com/budget/v4/delete/budgetItemHeader/{syncGuid}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/www.concursolutions.com/budget/v4/delete/budgetItemHeader/{syncGuid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/www.concursolutions.com/budget/v4/delete/budgetItemHeader/{syncGuid}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /budget/v4/delete/budgetItemHeader/{syncGuid}
Remove budget item permanently
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| syncGuid | path | string | true | Budget item guid |
Example responses
200 Response
{
"budgetItemHeaderSyncGuid": "string",
"success": true
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | BudgetItemHeaderResponse |
| 204 | No Content | No Content | None |
| 400 | Bad Request | Invalid request | None |
| 401 | Unauthorized | Unauthorized | None |
| 403 | Forbidden | Forbidden | None |
| 500 | Internal Server Error | Internal error | None |
Cost Object Field
Cost Object Field
getFieldListByEntityIdUsingGET
Code samples
# You can also use wget
curl -X GET /www.concursolutions.com/budget/v4/budgetTrackingField \
-H 'Accept: application/json'
GET /www.concursolutions.com/budget/v4/budgetTrackingField HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('/www.concursolutions.com/budget/v4/budgetTrackingField',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get '/www.concursolutions.com/budget/v4/budgetTrackingField',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('/www.concursolutions.com/budget/v4/budgetTrackingField', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/www.concursolutions.com/budget/v4/budgetTrackingField', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/www.concursolutions.com/budget/v4/budgetTrackingField");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/www.concursolutions.com/budget/v4/budgetTrackingField", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /budget/v4/budgetTrackingField
Fetches the list of cost object fields in the system for an entity
Example responses
200 Response
[
{
"budgetSequenceNumber": 0,
"budgetTrackingFieldName": "string",
"connectedListSequenceNumber": 0,
"feildType": "string",
"fieldDefinitionId": "string",
"fieldId": "string",
"fieldSyncGuid": "string",
"listSyncGuid": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Inline |
| 400 | Bad Request | Invalid request | None |
| 401 | Unauthorized | Unauthorized | None |
| 403 | Forbidden | Forbidden | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal error | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [CostObjectField] | false | none | none |
| » budgetSequenceNumber | integer(int32) | false | none | none |
| » budgetTrackingFieldName | string | false | none | none |
| » connectedListSequenceNumber | integer | false | none | none |
| » feildType | string | false | none | none |
| » fieldDefinitionId | string | false | none | none |
| » fieldId | string | false | none | none |
| » fieldSyncGuid | string | false | none | none |
| » listSyncGuid | string | false | none | none |
Fiscal Year
getFiscalYearByEntityIdAndBylastModifiedAfterUsingGET
Code samples
# You can also use wget
curl -X GET /www.concursolutions.com/budget/v4/fiscalYear \
-H 'Accept: application/json'
GET /www.concursolutions.com/budget/v4/fiscalYear HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('/www.concursolutions.com/budget/v4/fiscalYear',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get '/www.concursolutions.com/budget/v4/fiscalYear',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('/www.concursolutions.com/budget/v4/fiscalYear', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/www.concursolutions.com/budget/v4/fiscalYear', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/www.concursolutions.com/budget/v4/fiscalYear");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/www.concursolutions.com/budget/v4/fiscalYear", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /budget/v4/fiscalYear
Fetches the list of fiscal years in the system for an entity.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| includeRemoved | query | boolean | false | includeRemoved |
| lastModifiedAfter | query | string | false | lastModifiedAfter |
Example responses
200 Response
[
{
"currentYear": true,
"customFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"displayName": "string",
"endDate": "2019-08-24",
"fiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"id": "string",
"lastModified": "2019-08-24T14:15:22Z",
"monthlyFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"name": "string",
"openAndClosedFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"quarterlyFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"startDate": "2019-08-24",
"status": "OPEN",
"syncGuid": "string",
"yearlyFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
]
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Inline |
| 400 | Bad Request | Invalid request | None |
| 401 | Unauthorized | Unauthorized | None |
| 403 | Forbidden | Forbidden | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal error | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [FiscalYear] | false | none | none |
| » currentYear | boolean | true | none | Is this the current fiscal year based on the current time? |
| » customFiscalPeriods | [FiscalPeriod] | false | none | none |
| »» currentPeriod | boolean | true | none | Is this the current period based on the current date/time? |
| »» endDate | string(date) | true | none | The end date of the fiscal period. Must be within the parent fiscal year. |
| »» fiscalPeriodStatus | string | false | none | The status of the fiscal period. Open, closed, and removed are valid. |
| »» fiscalYearSyncGuid | string | false | none | none |
| »» id | string | false | none | The unique identifier for the fiscal period. |
| »» name | string | true | none | Name of the fiscal period. Must be unique for the entity. |
| »» periodType | string | true | none | The type of fiscal period |
| »» spendDate | string(date) | true | none | The spend date of the fiscal period. Must be within the parent fiscal year. |
| »» startDate | string(date) | true | none | The start date of the fiscal period. Must be within the parent fiscal year. |
| »» syncGuid | string | false | none | The unique identifier for the fiscal period. |
| » displayName | string | false | none | Display name for fiscal year. For date range budget item we use this field to display |
| » endDate | string(date) | true | none | The end date for this fiscal year. The distance between start date and end date may not be more than two years. |
| » fiscalPeriods | [FiscalPeriod] | false | none | none |
| » id | string | false | none | The unique identifier of the fiscal year. |
| » lastModified | string(date-time) | false | none | The last time the fiscal year was updated. Date in UTC. READ ONLY |
| » monthlyFiscalPeriods | [FiscalPeriod] | false | none | none |
| » name | string | true | none | The name of this fiscal year. Must be unique for this entity. |
| » openAndClosedFiscalPeriods | [FiscalPeriod] | false | none | none |
| » quarterlyFiscalPeriods | [FiscalPeriod] | false | none | none |
| » startDate | string(date) | true | none | The start date for this fiscal year |
| » status | string | false | none | The status of this fiscal year. Open, closed, and removed are valid. |
| » syncGuid | string | false | none | The unique identifier of the fiscal year. |
| » yearlyFiscalPeriods | [FiscalPeriod] | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| fiscalPeriodStatus | OPEN |
| fiscalPeriodStatus | CLOSED |
| fiscalPeriodStatus | REMOVED |
| fiscalPeriodStatus | MERGED |
| periodType | MONTHLY |
| periodType | QUARTERLY |
| periodType | YEARLY |
| periodType | CUSTOM |
| periodType | DATE_RANGE |
| status | OPEN |
| status | CLOSED |
| status | REMOVED |
| status | MERGED |
saveFiscalYearUsingPOST
Code samples
# You can also use wget
curl -X POST /www.concursolutions.com/budget/v4/fiscalYear \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
POST /www.concursolutions.com/budget/v4/fiscalYear HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '[
{
"currentYear": true,
"customFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"displayName": "string",
"endDate": "2019-08-24",
"fiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"id": "string",
"lastModified": "2019-08-24T14:15:22Z",
"monthlyFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"name": "string",
"openAndClosedFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"quarterlyFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"startDate": "2019-08-24",
"status": "OPEN",
"syncGuid": "string",
"yearlyFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
]
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('/www.concursolutions.com/budget/v4/fiscalYear',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post '/www.concursolutions.com/budget/v4/fiscalYear',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('/www.concursolutions.com/budget/v4/fiscalYear', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/www.concursolutions.com/budget/v4/fiscalYear', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/www.concursolutions.com/budget/v4/fiscalYear");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/www.concursolutions.com/budget/v4/fiscalYear", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /budget/v4/fiscalYear
Save fiscal year. Creates a new fiscal year if one doesn't exist.
Body parameter
[
{
"currentYear": true,
"customFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"displayName": "string",
"endDate": "2019-08-24",
"fiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"id": "string",
"lastModified": "2019-08-24T14:15:22Z",
"monthlyFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"name": "string",
"openAndClosedFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"quarterlyFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"startDate": "2019-08-24",
"status": "OPEN",
"syncGuid": "string",
"yearlyFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
]
}
]
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| forceSave | query | boolean | false | forceSave |
| body | body | FiscalYear | true | fiscalYearsList |
Example responses
200 Response
[
{
"currentYear": true,
"customFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"displayName": "string",
"endDate": "2019-08-24",
"fiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"id": "string",
"lastModified": "2019-08-24T14:15:22Z",
"monthlyFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"name": "string",
"openAndClosedFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"quarterlyFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"startDate": "2019-08-24",
"status": "OPEN",
"syncGuid": "string",
"yearlyFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
]
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Inline |
| 201 | Created | Created | None |
| 400 | Bad Request | Invalid request | None |
| 401 | Unauthorized | Unauthorized | None |
| 403 | Forbidden | Forbidden | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal error | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [FiscalYear] | false | none | none |
| » currentYear | boolean | true | none | Is this the current fiscal year based on the current time? |
| » customFiscalPeriods | [FiscalPeriod] | false | none | none |
| »» currentPeriod | boolean | true | none | Is this the current period based on the current date/time? |
| »» endDate | string(date) | true | none | The end date of the fiscal period. Must be within the parent fiscal year. |
| »» fiscalPeriodStatus | string | false | none | The status of the fiscal period. Open, closed, and removed are valid. |
| »» fiscalYearSyncGuid | string | false | none | none |
| »» id | string | false | none | The unique identifier for the fiscal period. |
| »» name | string | true | none | Name of the fiscal period. Must be unique for the entity. |
| »» periodType | string | true | none | The type of fiscal period |
| »» spendDate | string(date) | true | none | The spend date of the fiscal period. Must be within the parent fiscal year. |
| »» startDate | string(date) | true | none | The start date of the fiscal period. Must be within the parent fiscal year. |
| »» syncGuid | string | false | none | The unique identifier for the fiscal period. |
| » displayName | string | false | none | Display name for fiscal year. For date range budget item we use this field to display |
| » endDate | string(date) | true | none | The end date for this fiscal year. The distance between start date and end date may not be more than two years. |
| » fiscalPeriods | [FiscalPeriod] | false | none | none |
| » id | string | false | none | The unique identifier of the fiscal year. |
| » lastModified | string(date-time) | false | none | The last time the fiscal year was updated. Date in UTC. READ ONLY |
| » monthlyFiscalPeriods | [FiscalPeriod] | false | none | none |
| » name | string | true | none | The name of this fiscal year. Must be unique for this entity. |
| » openAndClosedFiscalPeriods | [FiscalPeriod] | false | none | none |
| » quarterlyFiscalPeriods | [FiscalPeriod] | false | none | none |
| » startDate | string(date) | true | none | The start date for this fiscal year |
| » status | string | false | none | The status of this fiscal year. Open, closed, and removed are valid. |
| » syncGuid | string | false | none | The unique identifier of the fiscal year. |
| » yearlyFiscalPeriods | [FiscalPeriod] | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| fiscalPeriodStatus | OPEN |
| fiscalPeriodStatus | CLOSED |
| fiscalPeriodStatus | REMOVED |
| fiscalPeriodStatus | MERGED |
| periodType | MONTHLY |
| periodType | QUARTERLY |
| periodType | YEARLY |
| periodType | CUSTOM |
| periodType | DATE_RANGE |
| status | OPEN |
| status | CLOSED |
| status | REMOVED |
| status | MERGED |
getFiscalYearUsingGET
Code samples
# You can also use wget
curl -X GET /www.concursolutions.com/budget/v4/fiscalYear/{syncguid} \
-H 'Accept: application/json'
GET /www.concursolutions.com/budget/v4/fiscalYear/{syncguid} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('/www.concursolutions.com/budget/v4/fiscalYear/{syncguid}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get '/www.concursolutions.com/budget/v4/fiscalYear/{syncguid}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('/www.concursolutions.com/budget/v4/fiscalYear/{syncguid}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/www.concursolutions.com/budget/v4/fiscalYear/{syncguid}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/www.concursolutions.com/budget/v4/fiscalYear/{syncguid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/www.concursolutions.com/budget/v4/fiscalYear/{syncguid}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /budget/v4/fiscalYear/{syncguid}
Fetches an individual fiscal year from the system by guid.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| syncguid | path | string | true | Fiscal year guid |
Example responses
200 Response
{
"currentYear": true,
"customFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"displayName": "string",
"endDate": "2019-08-24",
"fiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"id": "string",
"lastModified": "2019-08-24T14:15:22Z",
"monthlyFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"name": "string",
"openAndClosedFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"quarterlyFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"startDate": "2019-08-24",
"status": "OPEN",
"syncGuid": "string",
"yearlyFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | FiscalYear |
| 400 | Bad Request | Invalid request | None |
| 401 | Unauthorized | Unauthorized | None |
| 403 | Forbidden | Forbidden | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal error | None |
removeFiscalYearUsingDELETE
Code samples
# You can also use wget
curl -X DELETE /www.concursolutions.com/budget/v4/fiscalYear/{syncguid} \
-H 'Accept: application/json'
DELETE /www.concursolutions.com/budget/v4/fiscalYear/{syncguid} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('/www.concursolutions.com/budget/v4/fiscalYear/{syncguid}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.delete '/www.concursolutions.com/budget/v4/fiscalYear/{syncguid}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.delete('/www.concursolutions.com/budget/v4/fiscalYear/{syncguid}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/www.concursolutions.com/budget/v4/fiscalYear/{syncguid}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/www.concursolutions.com/budget/v4/fiscalYear/{syncguid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/www.concursolutions.com/budget/v4/fiscalYear/{syncguid}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /budget/v4/fiscalYear/{syncguid}
Remove fiscal year
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| syncguid | path | string | true | Fiscal year guid |
Example responses
200 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | string |
| 204 | No Content | No Content | None |
| 400 | Bad Request | Invalid request | None |
| 401 | Unauthorized | Unauthorized | None |
| 403 | Forbidden | Forbidden | None |
| 500 | Internal Server Error | Internal error | None |
Schemas
BudgetAdjustmentsExternal
{
"adjustmentType": "BUDGET_BALANCE",
"amount": 500,
"amountType": "BUDGET_AMOUNT",
"budgetItemName": "Marketing",
"budgetOwnerEmail": "name@compamy.com",
"description": "Sample description",
"fiscalPeriodName": "2018 - Q3",
"fiscalYearName": 2018,
"transactionDate": "2018-07-11"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| adjustmentType | string | false | none | The type of adjustment being made. Only a user reference field |
| amount | number | true | none | The value of the amount adjusted (+/-) |
| amountType | string | true | none | The type of the amount that is being adjusted |
| budgetItemName | string | true | none | The name of the budget item to which the adjustment is being made |
| budgetOwnerEmail | string | true | none | The owner email Id of the budget item |
| description | string | false | none | The short description of the adjustment |
| fiscalPeriodName | string | true | none | The specific fiscal period when this budget amount will be used. |
| fiscalYearName | string | true | none | The Fiscal year of the budget item |
| transactionDate | string(date) | false | none | The transaction date of adjusted spend. Required when the adjustment is made for amount type SPENT_AMOUNT or PENDING_AMOUNT |
Enumerated Values
| Property | Value |
|---|---|
| adjustmentType | BUDGET_BALANCE |
| adjustmentType | FUND_TRANSFER |
| adjustmentType | EXPENSE |
| adjustmentType | PAYMENT_REQUEST |
| adjustmentType | PURCHASE_REQUEST |
| adjustmentType | REQUEST |
| adjustmentType | PURGE_ADJUSTMENT |
| amountType | BUDGET_AMOUNT |
| amountType | SPENT_AMOUNT |
| amountType | PENDING_AMOUNT |
BudgetAmount
{
"adjustedBudgetAmount": 0,
"availableAmount": 0,
"consumedPercent": 0,
"pendingAmount": 0,
"spendAmount": 0,
"threshold": "UNDER",
"unExpensedAmount": 0,
"unExpensedSettings": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| adjustedBudgetAmount | number | false | none | The amount adjusted against this budget. READ ONLY |
| availableAmount | number | false | none | The available amount accumulated against this budget. Uses budget entity setting to determine which amounts are included to calculate available amount. READ ONLY |
| consumedPercent | number | false | none | The percentage of the budget that is considered used. Uses budget entity setting to determine which amounts to include. READ ONLY |
| pendingAmount | number | false | none | The pending amount accumulated against this budget. READ ONLY |
| spendAmount | number | false | none | The spend amount accumulated against this budget. READ ONLY |
| threshold | string | false | none | The indicator of whether this budget is under the alert limit (UNDER), equal to or over the alert limit, but under the control limit (ALERT), or equal to or over the control limit (OVER). READ ONLY |
| unExpensedAmount | number | false | none | The pending amount accumulated against this budget. READ ONLY |
| unExpensedSettings | boolean | false | none | The unexpensed settings is used to decided to show unexpensed balance or not. READ ONLY |
Enumerated Values
| Property | Value |
|---|---|
| threshold | UNDER |
| threshold | ALERT |
| threshold | OVER |
| threshold | UNKNOWN |
BudgetCategory
{
"description": "string",
"expenseTypes": [
{
"expenseTypeCode": "string",
"featureTypeCode": "REQUEST",
"id": "string",
"name": "string",
"syncGuid": "string"
}
],
"id": "string",
"name": "string",
"statusType": "OPEN",
"syncGuid": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description | string | false | none | none |
| expenseTypes | [ExpenseType] | true | none | The list of expense types that this budget category matches. |
| id | string | false | none | The unique identifier for the budget category. |
| name | string | true | none | The name of this budget category. |
| statusType | string | false | none | The status of this budget category--only open and removed are meaningful for budget category. |
| syncGuid | string | false | none | The unique identifier for the budget category. |
Enumerated Values
| Property | Value |
|---|---|
| statusType | OPEN |
| statusType | CLOSED |
| statusType | REMOVED |
| statusType | MERGED |
BudgetItemBalance
{
"amount": 0,
"featureTypeCode": "REQUEST",
"featureTypeSubCode": "QUICK_EXPENSE",
"id": "string",
"syncGuid": "string",
"workflowState": "NONE"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| amount | number | false | none | none |
| featureTypeCode | string | false | none | The feature type for this balance. |
| featureTypeSubCode | string | false | none | The feature type sub code for this balance. |
| id | string | false | none | The unique identifier for this particular budget balance bucket |
| syncGuid | string | false | none | The unique identifier for this particular budget balance bucket |
| workflowState | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| featureTypeCode | REQUEST |
| featureTypeCode | TRAVEL |
| featureTypeCode | EXPENSE |
| featureTypeCode | PAYMENT_REQUEST |
| featureTypeCode | PURCHASE_REQUEST |
| featureTypeCode | ADJUSTMENT |
| featureTypeCode | EMPLOYEE |
| featureTypeSubCode | QUICK_EXPENSE |
| featureTypeSubCode | ERECEIPT |
| featureTypeSubCode | CREDIT_CARD |
| featureTypeSubCode | PERSONAL_CARD |
| featureTypeSubCode | TRIP |
| featureTypeSubCode | RECEIPT_CAPTURE |
| featureTypeSubCode | BILLING_STATEMENT |
| featureTypeSubCode | MANUAL |
| featureTypeSubCode | NONE |
| featureTypeSubCode | BUDGET_AMOUNT |
| featureTypeSubCode | SPENT_AMOUNT |
| featureTypeSubCode | PENDING_AMOUNT |
| featureTypeSubCode | PRE_AUTHORIZED |
| featureTypeSubCode | PURGE_ADJUSTMENT |
| workflowState | NONE |
| workflowState | UNEXPENSED |
| workflowState | UNSUBMITTED |
| workflowState | UNSUBMITTED_HELD |
| workflowState | SUBMITTED |
| workflowState | APPROVED |
| workflowState | PROCESSED |
| workflowState | PAID |
BudgetItemDetail
{
"amount": 0,
"budgetAmounts": {
"adjustedBudgetAmount": 0,
"availableAmount": 0,
"consumedPercent": 0,
"pendingAmount": 0,
"spendAmount": 0,
"threshold": "UNDER",
"unExpensedAmount": 0,
"unExpensedSettings": true
},
"budgetItemBalances": [
{
"amount": 0,
"featureTypeCode": "REQUEST",
"featureTypeSubCode": "QUICK_EXPENSE",
"id": "string",
"syncGuid": "string",
"workflowState": "NONE"
}
],
"budgetItemDetailStatusType": "OPEN",
"budgetItemHeaderId": "string",
"budgetItemHeaderSyncGuid": "string",
"budgetName": "string",
"currencyCode": "string",
"detailDashboardBudgetItemAdjustments": [
{
"adjustedBy": "string",
"adjustmentType": "BUDGET_BALANCE",
"amount": 0,
"amountType": "QUICK_EXPENSE",
"description": "string",
"transactionDate": "2019-08-24"
}
],
"fiscalPeriod": {
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
},
"fiscalPeriodId": "string",
"id": "string",
"syncGuid": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| amount | number | false | none | The currency amount allocated to this fiscal period. |
| budgetAmounts | BudgetAmount | false | none | The total budget amount and accumulated balances for this budget detail. READ ONLY |
| budgetItemBalances | [BudgetItemBalance] | false | none | READONLY |
| budgetItemDetailStatusType | string | false | none | The status of the budget item detail. Only open, closed, and removed are valid. |
| budgetItemHeaderId | string | false | none | The unique id of the header that contains this budget item detail. |
| budgetItemHeaderSyncGuid | string | false | none | The unique id of the header that contains this budget item detail. |
| budgetName | string | false | none | none |
| currencyCode | string | true | none | The alpha currency code, e.g. USD or GBP |
| detailDashboardBudgetItemAdjustments | [DetailDashboardBudgetItemAdjustment] | false | none | none |
| fiscalPeriod | FiscalPeriod | true | none | The specific fiscal period when this budget amount will be used. |
| fiscalPeriodId | string | false | none | none |
| id | string | false | none | The unique identifier for this budget item detail |
| syncGuid | string | false | none | The unique identifier for this budget item detail |
Enumerated Values
| Property | Value |
|---|---|
| budgetItemDetailStatusType | OPEN |
| budgetItemDetailStatusType | CLOSED |
| budgetItemDetailStatusType | REMOVED |
| budgetItemDetailStatusType | MERGED |
BudgetItemHeader
{
"active": true,
"annualBudget": 0,
"budgetAmounts": {
"adjustedBudgetAmount": 0,
"availableAmount": 0,
"consumedPercent": 0,
"pendingAmount": 0,
"spendAmount": 0,
"threshold": "UNDER",
"unExpensedAmount": 0,
"unExpensedSettings": true
},
"budgetApprovers": [
{
"email": "string",
"employeeId": "string",
"employeeUuid": "string",
"externalUserCUUID": "string",
"externalUserSyncGuid": "string",
"id": "string",
"name": "string",
"syncGuid": "string"
}
],
"budgetCategory": {
"description": "string",
"expenseTypes": [
{
"expenseTypeCode": "string",
"featureTypeCode": "REQUEST",
"id": "string",
"name": "string",
"syncGuid": "string"
}
],
"id": "string",
"name": "string",
"statusType": "OPEN",
"syncGuid": "string"
},
"budgetItemDetails": [
{
"amount": 0,
"budgetAmounts": {
"adjustedBudgetAmount": 0,
"availableAmount": 0,
"consumedPercent": 0,
"pendingAmount": 0,
"spendAmount": 0,
"threshold": "UNDER",
"unExpensedAmount": 0,
"unExpensedSettings": true
},
"budgetItemBalances": [
{
"amount": 0,
"featureTypeCode": "REQUEST",
"featureTypeSubCode": "QUICK_EXPENSE",
"id": "string",
"syncGuid": "string",
"workflowState": "NONE"
}
],
"budgetItemDetailStatusType": "OPEN",
"budgetItemHeaderId": "string",
"budgetItemHeaderSyncGuid": "string",
"budgetName": "string",
"currencyCode": "string",
"detailDashboardBudgetItemAdjustments": [
{
"adjustedBy": "string",
"adjustmentType": "BUDGET_BALANCE",
"amount": 0,
"amountType": "QUICK_EXPENSE",
"description": "string",
"transactionDate": "2019-08-24"
}
],
"fiscalPeriod": {
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
},
"fiscalPeriodId": "string",
"id": "string",
"syncGuid": "string"
}
],
"budgetItemStatusType": "OPEN",
"budgetManagers": [
{
"email": "string",
"employeeId": "string",
"employeeUuid": "string",
"externalUserCUUID": "string",
"externalUserSyncGuid": "string",
"id": "string",
"name": "string",
"syncGuid": "string"
}
],
"budgetType": "PERSONAL_USE",
"budgetViewers": [
{
"email": "string",
"employeeId": "string",
"employeeUuid": "string",
"externalUserCUUID": "string",
"externalUserSyncGuid": "string",
"id": "string",
"name": "string",
"syncGuid": "string"
}
],
"costObjects": [
{
"code": "string",
"displayName": "string",
"fieldDefinitionId": "string",
"listKey": "string",
"listName": "string",
"operator": "EQUAL",
"value": "string"
}
],
"createdDate": "2019-08-24T14:15:22Z",
"currencyCode": "string",
"dateRange": {
"endDate": "2019-08-24",
"startDate": "2019-08-24"
},
"description": "string",
"fiscalYear": {
"currentYear": true,
"customFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"displayName": "string",
"endDate": "2019-08-24",
"fiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"id": "string",
"lastModified": "2019-08-24T14:15:22Z",
"monthlyFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"name": "string",
"openAndClosedFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"quarterlyFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"startDate": "2019-08-24",
"status": "OPEN",
"syncGuid": "string",
"yearlyFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
]
},
"fiscalYearId": "string",
"id": "string",
"isTest": true,
"lastModifiedDate": "2019-08-24T14:15:22Z",
"name": "string",
"owned": true,
"owner": {
"email": "string",
"employeeId": "string",
"employeeUuid": "string",
"externalUserCUUID": "string",
"externalUserSyncGuid": "string",
"id": "string",
"name": "string",
"syncGuid": "string"
},
"periodType": "MONTHLY",
"syncGuid": "string",
"test": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| active | boolean | false | none | Indicates if this budget should be displayed on user screens READ ONLY |
| annualBudget | number | false | none | The total budget amount and accumulated balances for this budget header. READ ONLY |
| budgetAmounts | BudgetAmount | false | none | The total budget amount and accumulated balances for this budget header. READ ONLY |
| budgetApprovers | [BudgetPerson] | false | none | The users who can approve spending for this budget. |
| budgetCategory | BudgetCategory | false | none | The budget category for this budget item. If a budget category is present, spending items must match one of the expense types in the budget category in order to match this budget. |
| budgetItemDetails | [BudgetItemDetail] | false | none | none |
| budgetItemStatusType | string | true | none | The status of this budget item. Merged is invalid for Budget Items. (Closed means no spending may be attached to this budget.) |
| budgetManagers | [BudgetPerson] | false | none | If managers exist, spend items only matches this budget if one of the managers is in the manager hierarchy of the submitter or approver for the given spend item. |
| budgetType | string | false | none | The budget type indicates if the budget item is personal or not |
| budgetViewers | [BudgetPerson] | false | none | The users who can view this budget. |
| costObjects | [HierarchyValue] | false | none | The cost object list for matching spending items. |
| createdDate | string(date-time) | false | none | The time the budget item header was created. Date in UTC. READ ONLY |
| currencyCode | string | false | none | The currency code of the first budget detail. Moved to this level for convenience since it's very rare for a budget item header to have details with different currency codes. |
| dateRange | DateRange | false | none | none |
| description | string | true | none | The friendly name for a budget item. |
| fiscalYear | FiscalYear | false | none | none |
| fiscalYearId | string | false | none | none |
| id | string | false | none | The unique identifier for the budget item. |
| isTest | boolean | false | none | The test flag for the budget item |
| lastModifiedDate | string(date-time) | false | none | The last time the budget item header was updated. Date in UTC. READ ONLY |
| name | string | true | none | The admin-facing name of this budget |
| owned | boolean | false | none | Indicates if this budget is owned by the current user READ ONLY |
| owner | BudgetPerson | true | none | The user who is ultimately responsible for this budget. He/she may approve spending for the budget |
| periodType | string | false | none | The type of period within the fiscal year that this budget uses READ ONLY |
| syncGuid | string | false | none | The unique identifier for the budget item. |
| test | boolean | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| budgetItemStatusType | OPEN |
| budgetItemStatusType | CLOSED |
| budgetItemStatusType | REMOVED |
| budgetItemStatusType | MERGED |
| budgetType | PERSONAL_USE |
| budgetType | BUDGET |
| budgetType | RESTRICTED |
| periodType | MONTHLY |
| periodType | QUARTERLY |
| periodType | YEARLY |
| periodType | CUSTOM |
| periodType | DATE_RANGE |
BudgetItemHeaderResponse
{
"budgetItemHeaderSyncGuid": "string",
"success": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| budgetItemHeaderSyncGuid | string | false | none | none |
| success | boolean | false | none | none |
BudgetPerson
{
"email": "string",
"employeeId": "string",
"employeeUuid": "string",
"externalUserCUUID": "string",
"externalUserSyncGuid": "string",
"id": "string",
"name": "string",
"syncGuid": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| string | false | none | populate user email | |
| employeeId | string | false | none | populate user employeeId |
| employeeUuid | string | true | none | The unique identifier for this user. This must match the UUID from Concur's profile service. |
| externalUserCUUID | string | true | none | The unique identifier for this user. This must match the CUUID from Concur's profile service. |
| externalUserSyncGuid | string | true | none | The unique identifier for this user. This must match the CUUID from Concur's profile service. |
| id | string | false | none | The budget service's unique identifier for this user. |
| name | string | false | none | none |
| syncGuid | string | false | none | The budget service's unique identifier for this user. |
CostObjectField
{
"budgetSequenceNumber": 0,
"budgetTrackingFieldName": "string",
"connectedListSequenceNumber": 0,
"feildType": "string",
"fieldDefinitionId": "string",
"fieldId": "string",
"fieldSyncGuid": "string",
"listSyncGuid": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| budgetSequenceNumber | integer(int32) | false | none | none |
| budgetTrackingFieldName | string | false | none | none |
| connectedListSequenceNumber | integer | false | none | none |
| feildType | string | false | none | none |
| fieldDefinitionId | string | false | none | none |
| fieldId | string | false | none | none |
| fieldSyncGuid | string | false | none | none |
| listSyncGuid | string | false | none | none |
DateRange
{
"endDate": "2019-08-24",
"startDate": "2019-08-24"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| endDate | string(date) | false | none | The end date for the budget. |
| startDate | string(date) | false | none | The start date for the budget. |
DetailDashboardBudgetItemAdjustment
{
"adjustedBy": "string",
"adjustmentType": "BUDGET_BALANCE",
"amount": 0,
"amountType": "QUICK_EXPENSE",
"description": "string",
"transactionDate": "2019-08-24"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| adjustedBy | string | false | none | The User who added or updated this adjustment |
| adjustmentType | string | false | none | The type of adjustment being made. Only a user reference field |
| amount | number | true | none | The value of the amount adjusted (+/-) |
| amountType | string | false | none | The amount type of the field |
| description | string | false | none | The short description of the adjustment |
| transactionDate | string(date) | false | none | The transaction date of adjusted spend. Required when the adjustment is made for amount type SPENT_AMOUNT or PENDING_AMOUNT |
Enumerated Values
| Property | Value |
|---|---|
| adjustmentType | BUDGET_BALANCE |
| adjustmentType | FUND_TRANSFER |
| adjustmentType | EXPENSE |
| adjustmentType | PAYMENT_REQUEST |
| adjustmentType | PURCHASE_REQUEST |
| adjustmentType | REQUEST |
| adjustmentType | PURGE_ADJUSTMENT |
| amountType | QUICK_EXPENSE |
| amountType | ERECEIPT |
| amountType | CREDIT_CARD |
| amountType | PERSONAL_CARD |
| amountType | TRIP |
| amountType | RECEIPT_CAPTURE |
| amountType | BILLING_STATEMENT |
| amountType | MANUAL |
| amountType | NONE |
| amountType | BUDGET_AMOUNT |
| amountType | SPENT_AMOUNT |
| amountType | PENDING_AMOUNT |
| amountType | PRE_AUTHORIZED |
| amountType | PURGE_ADJUSTMENT |
ExpenseType
{
"expenseTypeCode": "string",
"featureTypeCode": "REQUEST",
"id": "string",
"name": "string",
"syncGuid": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| expenseTypeCode | string | false | none | The alphanumeric code that describes an expense type. Ex: TRAVEL, AC_CATER Any string may be used, but only expense type codes returned by GET /budgetCategory/expenseType will behave properly in the Concur UI. |
| featureTypeCode | string | false | none | The type of feature that this expense type applies to, Purchase Request, Payment Request (Invoice), Expense or Travel Authorization |
| id | string | false | none | The unique idenifier for the expense type |
| name | string | true | none | none |
| syncGuid | string | false | none | The unique idenifier for the expense type |
Enumerated Values
| Property | Value |
|---|---|
| featureTypeCode | REQUEST |
| featureTypeCode | TRAVEL |
| featureTypeCode | EXPENSE |
| featureTypeCode | PAYMENT_REQUEST |
| featureTypeCode | PURCHASE_REQUEST |
| featureTypeCode | ADJUSTMENT |
| featureTypeCode | EMPLOYEE |
FiscalPeriod
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| currentPeriod | boolean | true | none | Is this the current period based on the current date/time? |
| endDate | string(date) | true | none | The end date of the fiscal period. Must be within the parent fiscal year. |
| fiscalPeriodStatus | string | false | none | The status of the fiscal period. Open, closed, and removed are valid. |
| fiscalYearSyncGuid | string | false | none | none |
| id | string | false | none | The unique identifier for the fiscal period. |
| name | string | true | none | Name of the fiscal period. Must be unique for the entity. |
| periodType | string | true | none | The type of fiscal period |
| spendDate | string(date) | true | none | The spend date of the fiscal period. Must be within the parent fiscal year. |
| startDate | string(date) | true | none | The start date of the fiscal period. Must be within the parent fiscal year. |
| syncGuid | string | false | none | The unique identifier for the fiscal period. |
Enumerated Values
| Property | Value |
|---|---|
| fiscalPeriodStatus | OPEN |
| fiscalPeriodStatus | CLOSED |
| fiscalPeriodStatus | REMOVED |
| fiscalPeriodStatus | MERGED |
| periodType | MONTHLY |
| periodType | QUARTERLY |
| periodType | YEARLY |
| periodType | CUSTOM |
| periodType | DATE_RANGE |
FiscalYear
{
"currentYear": true,
"customFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"displayName": "string",
"endDate": "2019-08-24",
"fiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"id": "string",
"lastModified": "2019-08-24T14:15:22Z",
"monthlyFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"name": "string",
"openAndClosedFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"quarterlyFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"startDate": "2019-08-24",
"status": "OPEN",
"syncGuid": "string",
"yearlyFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| currentYear | boolean | true | none | Is this the current fiscal year based on the current time? |
| customFiscalPeriods | [FiscalPeriod] | false | none | none |
| displayName | string | false | none | Display name for fiscal year. For date range budget item we use this field to display |
| endDate | string(date) | true | none | The end date for this fiscal year. The distance between start date and end date may not be more than two years. |
| fiscalPeriods | [FiscalPeriod] | false | none | none |
| id | string | false | none | The unique identifier of the fiscal year. |
| lastModified | string(date-time) | false | none | The last time the fiscal year was updated. Date in UTC. READ ONLY |
| monthlyFiscalPeriods | [FiscalPeriod] | false | none | none |
| name | string | true | none | The name of this fiscal year. Must be unique for this entity. |
| openAndClosedFiscalPeriods | [FiscalPeriod] | false | none | none |
| quarterlyFiscalPeriods | [FiscalPeriod] | false | none | none |
| startDate | string(date) | true | none | The start date for this fiscal year |
| status | string | false | none | The status of this fiscal year. Open, closed, and removed are valid. |
| syncGuid | string | false | none | The unique identifier of the fiscal year. |
| yearlyFiscalPeriods | [FiscalPeriod] | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| status | OPEN |
| status | CLOSED |
| status | REMOVED |
| status | MERGED |
HierarchyValue
{
"code": "string",
"displayName": "string",
"fieldDefinitionId": "string",
"listKey": "string",
"listName": "string",
"operator": "EQUAL",
"value": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| code | string | false | none | none |
| displayName | string | false | none | none |
| fieldDefinitionId | string | false | none | none |
| listKey | string | false | none | none |
| listName | string | false | none | none |
| operator | string | false | none | none |
| value | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| operator | EQUAL |
| operator | INLIST |
| operator | ISBLANK |
| operator | NOTEQUAL |
| operator | NOTINLIST |
| operator | ISNOTBLANK |
| operator | ISTRUE |
| operator | ISFALSE |
| operator | ISNOTTRUE |
| operator | ISNOTFALSE |
Href
{
"href": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| href | string | false | none | The fully qualified url |
PagedBudgetItemHeaderResult
{
"budgetItemHeaders": [
{
"active": true,
"annualBudget": 0,
"budgetAmounts": {
"adjustedBudgetAmount": 0,
"availableAmount": 0,
"consumedPercent": 0,
"pendingAmount": 0,
"spendAmount": 0,
"threshold": "UNDER",
"unExpensedAmount": 0,
"unExpensedSettings": true
},
"budgetApprovers": [
{
"email": "string",
"employeeId": "string",
"employeeUuid": "string",
"externalUserCUUID": "string",
"externalUserSyncGuid": "string",
"id": "string",
"name": "string",
"syncGuid": "string"
}
],
"budgetCategory": {
"description": "string",
"expenseTypes": [
{
"expenseTypeCode": "string",
"featureTypeCode": "REQUEST",
"id": "string",
"name": "string",
"syncGuid": "string"
}
],
"id": "string",
"name": "string",
"statusType": "OPEN",
"syncGuid": "string"
},
"budgetItemDetails": [
{
"amount": 0,
"budgetAmounts": {
"adjustedBudgetAmount": 0,
"availableAmount": 0,
"consumedPercent": 0,
"pendingAmount": 0,
"spendAmount": 0,
"threshold": "UNDER",
"unExpensedAmount": 0,
"unExpensedSettings": true
},
"budgetItemBalances": [
{
"amount": 0,
"featureTypeCode": "REQUEST",
"featureTypeSubCode": "QUICK_EXPENSE",
"id": "string",
"syncGuid": "string",
"workflowState": "NONE"
}
],
"budgetItemDetailStatusType": "OPEN",
"budgetItemHeaderId": "string",
"budgetItemHeaderSyncGuid": "string",
"budgetName": "string",
"currencyCode": "string",
"detailDashboardBudgetItemAdjustments": [
{
"adjustedBy": "string",
"adjustmentType": "BUDGET_BALANCE",
"amount": 0,
"amountType": "QUICK_EXPENSE",
"description": "string",
"transactionDate": "2019-08-24"
}
],
"fiscalPeriod": {
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
},
"fiscalPeriodId": "string",
"id": "string",
"syncGuid": "string"
}
],
"budgetItemStatusType": "OPEN",
"budgetManagers": [
{
"email": "string",
"employeeId": "string",
"employeeUuid": "string",
"externalUserCUUID": "string",
"externalUserSyncGuid": "string",
"id": "string",
"name": "string",
"syncGuid": "string"
}
],
"budgetType": "PERSONAL_USE",
"budgetViewers": [
{
"email": "string",
"employeeId": "string",
"employeeUuid": "string",
"externalUserCUUID": "string",
"externalUserSyncGuid": "string",
"id": "string",
"name": "string",
"syncGuid": "string"
}
],
"costObjects": [
{
"code": "string",
"displayName": "string",
"fieldDefinitionId": "string",
"listKey": "string",
"listName": "string",
"operator": "EQUAL",
"value": "string"
}
],
"createdDate": "2019-08-24T14:15:22Z",
"currencyCode": "string",
"dateRange": {
"endDate": "2019-08-24",
"startDate": "2019-08-24"
},
"description": "string",
"fiscalYear": {
"currentYear": true,
"customFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"displayName": "string",
"endDate": "2019-08-24",
"fiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"id": "string",
"lastModified": "2019-08-24T14:15:22Z",
"monthlyFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"name": "string",
"openAndClosedFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"quarterlyFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
],
"startDate": "2019-08-24",
"status": "OPEN",
"syncGuid": "string",
"yearlyFiscalPeriods": [
{
"currentPeriod": true,
"endDate": "2019-08-24",
"fiscalPeriodStatus": "OPEN",
"fiscalYearSyncGuid": "string",
"id": "string",
"name": "string",
"periodType": "MONTHLY",
"spendDate": "2019-08-24",
"startDate": "2019-08-24",
"syncGuid": "string"
}
]
},
"fiscalYearId": "string",
"id": "string",
"isTest": true,
"lastModifiedDate": "2019-08-24T14:15:22Z",
"name": "string",
"owned": true,
"owner": {
"email": "string",
"employeeId": "string",
"employeeUuid": "string",
"externalUserCUUID": "string",
"externalUserSyncGuid": "string",
"id": "string",
"name": "string",
"syncGuid": "string"
},
"periodType": "MONTHLY",
"syncGuid": "string",
"test": true
}
],
"href": "string",
"limit": 0,
"next": {
"href": "string"
},
"offset": 0,
"previous": {
"href": "string"
},
"totalRows": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| budgetItemHeaders | [BudgetItemHeader] | false | none | List of budget item headers. Each budget item header represents a single budget for a fiscal year. |
| href | string | true | none | The link to this page of results |
| limit | integer(int32) | false | none | The maximum number of entries a user can receive from this service. |
| next | Href | false | none | The link to the next page of results, if one exists. |
| offset | integer(int32) | false | none | The starting offset of this list inside the entire universe of results. Passing in a value larger than the total number of items for your search will result in an empty list. |
| previous | Href | false | none | The link to the previous page of results, if one exists. |
| totalRows | integer | false | none | Total number of records |
Invoice Pay v4.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
SAP Concur partners with external payment providers for processing invoice payments. These payment providers are listed on the App Center and can integrate with the Invoice product by using the Invoice Pay APIs. Payment providers can get a list of all the payments authorized to be processed by them, and send back status of those payments.
Base URLs:
Resources
manyUsingGET
Code samples
# You can also use wget
curl -X GET /www.concursolutions.com/invoice/provider-payment/v4/payments \
-H 'Accept: application/json'
GET /www.concursolutions.com/invoice/provider-payment/v4/payments HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('/www.concursolutions.com/invoice/provider-payment/v4/payments',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get '/www.concursolutions.com/invoice/provider-payment/v4/payments',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('/www.concursolutions.com/invoice/provider-payment/v4/payments', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/www.concursolutions.com/invoice/provider-payment/v4/payments', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/www.concursolutions.com/invoice/provider-payment/v4/payments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/www.concursolutions.com/invoice/provider-payment/v4/payments", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /invoice/provider-payment/v4/payments
Payment Providers can use this API to get details of payments marked to be paid by them
Example responses
200 Response
{
"payments": [
{
"invoices": [
{
"invoiceAmount": {
"amount": "string",
"currency": "str"
},
"invoiceId": "string",
"invoiceNumber": "string",
"notesToSupplier": "string",
"paymentAmount": {
"amount": "string",
"currency": "str"
}
}
],
"paymentDueDate": "2019-08-24",
"paymentId": "string",
"paymentMethod": "string",
"totalAmount": {
"amount": "string",
"currency": "str"
},
"vendor": {
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"buyerAccountNumber": "string",
"city": "string",
"countryCode": "string",
"countryName": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"phoneNumber": "string",
"postalCode": "string",
"state": "string",
"vendorAddrCode": "string",
"vendorCode": "string",
"vendorName": "string"
}
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | readPaymentResult |
| 401 | Unauthorized | Unauthorized | None |
| 403 | Forbidden | Forbidden | None |
| 404 | Not Found | Not Found | None |
oneUsingPOST
Code samples
# You can also use wget
curl -X POST /www.concursolutions.com/invoice/provider-payment/v4/payments/{PaymentId} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
POST /www.concursolutions.com/invoice/provider-payment/v4/payments/{PaymentId} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"paidAmount": {
"amount": "string",
"currency": "str"
},
"paymentAdjustmentNotes": "string",
"paymentInitiationDate": "2019-08-24",
"paymentMethod": "ACH",
"paymentSettlementDate": "2019-08-24",
"providerReference": "string",
"status": "PAID",
"statusDate": "2019-08-24",
"statusMessage": "string",
"thirdPartyPaymentIdentifier": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('/www.concursolutions.com/invoice/provider-payment/v4/payments/{PaymentId}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post '/www.concursolutions.com/invoice/provider-payment/v4/payments/{PaymentId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('/www.concursolutions.com/invoice/provider-payment/v4/payments/{PaymentId}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/www.concursolutions.com/invoice/provider-payment/v4/payments/{PaymentId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/www.concursolutions.com/invoice/provider-payment/v4/payments/{PaymentId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/www.concursolutions.com/invoice/provider-payment/v4/payments/{PaymentId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /invoice/provider-payment/v4/payments/{PaymentId}
Payment Providers can use this API to update the status of payments made by them
Body parameter
{
"paidAmount": {
"amount": "string",
"currency": "str"
},
"paymentAdjustmentNotes": "string",
"paymentInitiationDate": "2019-08-24",
"paymentMethod": "ACH",
"paymentSettlementDate": "2019-08-24",
"providerReference": "string",
"status": "PAID",
"statusDate": "2019-08-24",
"statusMessage": "string",
"thirdPartyPaymentIdentifier": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| PaymentId | path | string | true | PaymentId |
| body | body | updatePayment | true | Payment |
Example responses
200 Response
{
"createdDate": "2019-08-24T14:15:22Z",
"lastModifiedDate": "2019-08-24T14:15:22Z",
"paidAmount": {
"amount": "string",
"currency": "str"
},
"paymentAdjustmentNotes": "string",
"paymentInitiationDate": "2019-08-24",
"paymentMethod": "ACH",
"paymentSettlementDate": "2019-08-24",
"providerReference": "string",
"status": "PAID",
"statusDate": "2019-08-24",
"statusMessage": "string",
"thirdPartyPaymentIdentifier": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | updatePaymentResult |
| 201 | Created | Created | None |
| 401 | Unauthorized | Unauthorized | None |
| 403 | Forbidden | Forbidden | None |
| 404 | Not Found | Not Found | None |
Schemas
amount
{
"amount": "string",
"currency": "str"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| amount | string | false | none | Amount. Maximum 20 characters. |
| currency | string | false | none | Currency Code. Maximum 3 characters. |
invoice
{
"invoiceAmount": {
"amount": "string",
"currency": "str"
},
"invoiceId": "string",
"invoiceNumber": "string",
"notesToSupplier": "string",
"paymentAmount": {
"amount": "string",
"currency": "str"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| invoiceAmount | amount | false | none | none |
| invoiceId | string | false | none | Unique identifier of the invoice in SAP Concur. This can be used to get additional invoice information from other APIs. This is the same as paymentRequestID in other Invoice APIs. Maximum 20 characters. |
| invoiceNumber | string | false | none | Invoice Number. Maximum 50 characters. |
| notesToSupplier | string | false | none | Notes to the supplier contain remittance information that the buyer wants to provide to the supplier. Maximum 500 characters. |
| paymentAmount | amount | false | none | none |
payment
{
"invoices": [
{
"invoiceAmount": {
"amount": "string",
"currency": "str"
},
"invoiceId": "string",
"invoiceNumber": "string",
"notesToSupplier": "string",
"paymentAmount": {
"amount": "string",
"currency": "str"
}
}
],
"paymentDueDate": "2019-08-24",
"paymentId": "string",
"paymentMethod": "string",
"totalAmount": {
"amount": "string",
"currency": "str"
},
"vendor": {
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"buyerAccountNumber": "string",
"city": "string",
"countryCode": "string",
"countryName": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"phoneNumber": "string",
"postalCode": "string",
"state": "string",
"vendorAddrCode": "string",
"vendorCode": "string",
"vendorName": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| invoices | [invoice] | false | none | none |
| paymentDueDate | string(date) | false | none | The date by which the payment should be made. |
| paymentId | string | false | none | Unique identifier of the payment in SAP Concur. Maximum 36 characters. |
| paymentMethod | string | false | none | The value is always PAYPVD which means that the client wants to pay using a payment provider. Maximum 15 characters. |
| totalAmount | amount | false | none | none |
| vendor | vendor | false | none | none |
readPaymentResult
{
"payments": [
{
"invoices": [
{
"invoiceAmount": {
"amount": "string",
"currency": "str"
},
"invoiceId": "string",
"invoiceNumber": "string",
"notesToSupplier": "string",
"paymentAmount": {
"amount": "string",
"currency": "str"
}
}
],
"paymentDueDate": "2019-08-24",
"paymentId": "string",
"paymentMethod": "string",
"totalAmount": {
"amount": "string",
"currency": "str"
},
"vendor": {
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"buyerAccountNumber": "string",
"city": "string",
"countryCode": "string",
"countryName": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"phoneNumber": "string",
"postalCode": "string",
"state": "string",
"vendorAddrCode": "string",
"vendorCode": "string",
"vendorName": "string"
}
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| payments | [payment] | false | none | none |
updatePayment
{
"paidAmount": {
"amount": "string",
"currency": "str"
},
"paymentAdjustmentNotes": "string",
"paymentInitiationDate": "2019-08-24",
"paymentMethod": "ACH",
"paymentSettlementDate": "2019-08-24",
"providerReference": "string",
"status": "PAID",
"statusDate": "2019-08-24",
"statusMessage": "string",
"thirdPartyPaymentIdentifier": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| paidAmount | amount | false | none | none |
| paymentAdjustmentNotes | string | false | none | Payment adjustment notes sent by the payment provider. Maximum 255 characters. |
| paymentInitiationDate | string(date) | false | none | The date the payment was initiated. |
| paymentMethod | string | false | none | Payment method used by the payment provider. Required if the status is PAID, CHECK_PROCESSED, or CARD_SETTLED. |
| paymentSettlementDate | string(date) | false | none | The date the payment will be in the payees account. |
| providerReference | string | false | none | Unique identifier of the payment in the payment provider's system. This will be used for internal troubleshooting. Maximum 100 characters. |
| status | string | true | none | Used to depict success, error or any other intermediate state, defined by SAP Concur. |
| statusDate | string(date) | true | none | The date that the payment provider recorded this status change. |
| statusMessage | string | false | none | Payment provider description of the status. Providers can supply any message. Maximum 255 characters. |
| thirdPartyPaymentIdentifier | string | false | none | Check number if the payment was done via check or trace number for ACH payments. Maximum 255 characters. |
Enumerated Values
| Property | Value |
|---|---|
| paymentMethod | ACH |
| paymentMethod | CHECK |
| paymentMethod | WIRE |
| paymentMethod | CARD |
| paymentMethod | OTHER |
| status | PAID |
| status | CANCELED |
| status | CARD_AUTHORIZED |
| status | CARD_EMAIL_SENT |
| status | CARD_SETTLED |
| status | CHECK_MAILED |
| status | CHECK_PRINTED |
| status | CHECK_PROCESSED |
| status | CHECK_VOIDED |
| status | PENDING_RETRIEVAL |
| status | PROCESSING |
| status | REJECTED |
| status | RETRIEVED |
| status | RETURNED |
updatePaymentResult
{
"createdDate": "2019-08-24T14:15:22Z",
"lastModifiedDate": "2019-08-24T14:15:22Z",
"paidAmount": {
"amount": "string",
"currency": "str"
},
"paymentAdjustmentNotes": "string",
"paymentInitiationDate": "2019-08-24",
"paymentMethod": "ACH",
"paymentSettlementDate": "2019-08-24",
"providerReference": "string",
"status": "PAID",
"statusDate": "2019-08-24",
"statusMessage": "string",
"thirdPartyPaymentIdentifier": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| createdDate | string(date-time) | false | none | The date the payment was created. |
| lastModifiedDate | string(date-time) | false | none | The date the payment was last modified. |
| paidAmount | amount | false | none | none |
| paymentAdjustmentNotes | string | false | none | Payment adjustment notes sent by the payment provider. Maximum 255 characters. |
| paymentInitiationDate | string(date) | false | none | The date the payment was initiated. |
| paymentMethod | string | false | none | Payment method used by the payment provider. Required if the status is PAID, CHECK_PROCESSED, or CARD_SETTLED. |
| paymentSettlementDate | string(date) | false | none | The date the payment will be in the payees account. |
| providerReference | string | false | none | Unique identifier of the payment in the payment provider's system. Maximum 100 characters. |
| status | string | true | none | Used to depict success, error or any other intermediate state, defined by SAP Concur. |
| statusDate | string(date) | true | none | The date that the payment provider recorded this status change. |
| statusMessage | string | false | none | Payment provider description of the status. Providers can supply any message. Maximum 255 characters. |
| thirdPartyPaymentIdentifier | string | false | none | Check number if the payment was done via check or trace number for ACH payments. Maximum 255 characters. |
Enumerated Values
| Property | Value |
|---|---|
| paymentMethod | ACH |
| paymentMethod | CHECK |
| paymentMethod | WIRE |
| paymentMethod | CARD |
| paymentMethod | OTHER |
| status | PAID |
| status | CANCELED |
| status | CARD_AUTHORIZED |
| status | CARD_EMAIL_SENT |
| status | CARD_SETTLED |
| status | CHECK_MAILED |
| status | CHECK_PRINTED |
| status | CHECK_PROCESSED |
| status | CHECK_VOIDED |
| status | PENDING_RETRIEVAL |
| status | PROCESSING |
| status | REJECTED |
| status | RETRIEVED |
| status | RETURNED |
vendor
{
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"buyerAccountNumber": "string",
"city": "string",
"countryCode": "string",
"countryName": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"phoneNumber": "string",
"postalCode": "string",
"state": "string",
"vendorAddrCode": "string",
"vendorCode": "string",
"vendorName": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| addressLine1 | string | false | none | Vendor Address line 1. Maximum 255 characters. |
| addressLine2 | string | false | none | Vendor Address line 2. Maximum 255 characters. |
| addressLine3 | string | false | none | Vendor Address line 3. Maximum 255 characters. |
| buyerAccountNumber | string | false | none | Buyer Account Number. Maximum 50 characters. |
| city | string | false | none | Vendor Address City. Maximum 255 characters. |
| countryCode | string | false | none | Vendor Address Country Code. Maximum 2 characters. |
| countryName | string | false | none | Vendor Address Country Name. Maximum 64 characters. |
| string | false | none | Email Address. Maximum 255 characters. | |
| firstName | string | false | none | First Name. Maximum 255 characters. |
| lastName | string | false | none | Last Name. Maximum 255 characters. |
| phoneNumber | string | false | none | Phone Number. Maximum 25 characters. |
| postalCode | string | false | none | Vendor Address Postal Code. Maximum 20 characters. |
| state | string | false | none | Vendor Address State. Maximum 10 characters. |
| vendorAddrCode | string | false | none | Vendor Address Code. Maximum 64 characters. |
| vendorCode | string | false | none | Vendor Code. Maximum 32 characters. |
| vendorName | string | false | none | Vendor Name. Maximum 255 characters. |
Purchase Request v4.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
The Purchase Request API allows clients and partners to create and automatically submit purchase requests in the preauthorization workflow using the POST resource. With the GET resource you can retrieve the purchase request number, resulting purchase order number, workflow status, and any exception triggered for the records created.
Base URLs:
Resources
post_purchaserequest_v4_purchaserequests
Code samples
# You can also use wget
curl -X POST https://www.concursolutions.com/api/v4.0/purchaserequest/v4/purchaserequests/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Content-Type: string' \
-H 'Authorization: string' \
-H 'concur-correlationid: string'
POST https://www.concursolutions.com/api/v4.0/purchaserequest/v4/purchaserequests/ HTTP/1.1
Host: www.concursolutions.com
Content-Type: application/json
Accept: application/json
Content-Type: string
Authorization: string
concur-correlationid: string
const inputBody = '{
"description": "string",
"userId": "string",
"userEmail": "string",
"userLoginId": "string",
"policyExternalId": "string",
"currencyCode": "string",
"notesToSupplier": "string",
"comments": "string",
"custom1": "string",
"custom2": "string",
"custom3": "string",
"custom4": "string",
"custom5": "string",
"custom6": "string",
"custom7": "string",
"custom8": "string",
"custom9": "string",
"custom10": "string",
"custom11": "string",
"custom12": "string",
"custom13": "string",
"custom14": "string",
"custom15": "string",
"custom16": "string",
"custom17": "string",
"custom18": "string",
"custom19": "string",
"custom20": "string",
"custom21": "string",
"custom22": "string",
"custom23": "string",
"custom24": "string",
"shipToAddressCode": "string",
"billToAddressCode": "string",
"lineItems": {
"purchaseType": "string",
"vendorCode": "string",
"vendorAddressCode": "string",
"description": "string",
"quantity": "string",
"unitPrice": "string",
"expenseType": "string",
"receiptType": "string",
"neededByDate": null,
"uoMCode": "string",
"shipping": "string",
"tax": "string",
"supplierPartId": "string",
"url": "string",
"notesToVendor": "string",
"comments": "string",
"custom1": "string",
"custom2": "string",
"custom3": "string",
"custom4": "string",
"custom5": "string",
"custom6": "string",
"custom7": "string",
"custom8": "string",
"custom9": "string",
"custom10": "string",
"custom11": "string",
"custom12": "string",
"custom13": "string",
"custom14": "string",
"custom15": "string",
"custom16": "string",
"custom17": "string",
"custom18": "string",
"custom19": "string",
"custom20": "string"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Content-Type':'string',
'Authorization':'string',
'concur-correlationid':'string'
};
fetch('https://www.concursolutions.com/api/v4.0/purchaserequest/v4/purchaserequests/',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Content-Type' => 'string',
'Authorization' => 'string',
'concur-correlationid' => 'string'
}
result = RestClient.post 'https://www.concursolutions.com/api/v4.0/purchaserequest/v4/purchaserequests/',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Content-Type': 'string',
'Authorization': 'string',
'concur-correlationid': 'string'
}
r = requests.post('https://www.concursolutions.com/api/v4.0/purchaserequest/v4/purchaserequests/', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Content-Type' => 'string',
'Authorization' => 'string',
'concur-correlationid' => 'string',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://www.concursolutions.com/api/v4.0/purchaserequest/v4/purchaserequests/', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v4.0/purchaserequest/v4/purchaserequests/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Content-Type": []string{"string"},
"Authorization": []string{"string"},
"concur-correlationid": []string{"string"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://www.concursolutions.com/api/v4.0/purchaserequest/v4/purchaserequests/", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /purchaserequest/v4/purchaserequests/
Create a new purchase request
Create a Purchase Request based on provided header and line item details. If the request is valid it creates a purchase request and returns back a unique identifier to get the purchase request details.
Body parameter
{
"description": "string",
"userId": "string",
"userEmail": "string",
"userLoginId": "string",
"policyExternalId": "string",
"currencyCode": "string",
"notesToSupplier": "string",
"comments": "string",
"custom1": "string",
"custom2": "string",
"custom3": "string",
"custom4": "string",
"custom5": "string",
"custom6": "string",
"custom7": "string",
"custom8": "string",
"custom9": "string",
"custom10": "string",
"custom11": "string",
"custom12": "string",
"custom13": "string",
"custom14": "string",
"custom15": "string",
"custom16": "string",
"custom17": "string",
"custom18": "string",
"custom19": "string",
"custom20": "string",
"custom21": "string",
"custom22": "string",
"custom23": "string",
"custom24": "string",
"shipToAddressCode": "string",
"billToAddressCode": "string",
"lineItems": {
"purchaseType": "string",
"vendorCode": "string",
"vendorAddressCode": "string",
"description": "string",
"quantity": "string",
"unitPrice": "string",
"expenseType": "string",
"receiptType": "string",
"neededByDate": null,
"uoMCode": "string",
"shipping": "string",
"tax": "string",
"supplierPartId": "string",
"url": "string",
"notesToVendor": "string",
"comments": "string",
"custom1": "string",
"custom2": "string",
"custom3": "string",
"custom4": "string",
"custom5": "string",
"custom6": "string",
"custom7": "string",
"custom8": "string",
"custom9": "string",
"custom10": "string",
"custom11": "string",
"custom12": "string",
"custom13": "string",
"custom14": "string",
"custom15": "string",
"custom16": "string",
"custom17": "string",
"custom18": "string",
"custom19": "string",
"custom20": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Content-Type | header | string | true | Content Type. |
| Authorization | header | string | true | Bearer Token that identifies the caller. This is the Company or User access token. |
| concur-correlationid | header | string | false | Concur specific custom header used for technical support in the form of a RFC 4122 A Universally Unique IDentifier (UUID) URN Namespace. |
| body | body | purchaseRequest | true | The details of the purchase request. |
Example responses
200 Response
{
"id": "string",
"uri": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | purchaseRequestResponse |
| 400 | Bad Request | Bad Request | errors |
| 401 | Unauthorized | Unauthorized | None |
| 500 | Internal Server Error | Internal Server Error | None |
| 503 | Service Unavailable | Service Unavailable | None |
get_purchaserequest_v4_purchaserequests{id}
Code samples
# You can also use wget
curl -X GET https://www.concursolutions.com/api/v4.0/purchaserequest/v4/purchaserequests/{id}?mode=COMPACT \
-H 'Accept: application/json' \
-H 'Content-Type: string' \
-H 'Authorization: string' \
-H 'concur-correlationid: string'
GET https://www.concursolutions.com/api/v4.0/purchaserequest/v4/purchaserequests/{id}?mode=COMPACT HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
Content-Type: string
Authorization: string
concur-correlationid: string
const headers = {
'Accept':'application/json',
'Content-Type':'string',
'Authorization':'string',
'concur-correlationid':'string'
};
fetch('https://www.concursolutions.com/api/v4.0/purchaserequest/v4/purchaserequests/{id}?mode=COMPACT',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Content-Type' => 'string',
'Authorization' => 'string',
'concur-correlationid' => 'string'
}
result = RestClient.get 'https://www.concursolutions.com/api/v4.0/purchaserequest/v4/purchaserequests/{id}?mode=COMPACT',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Content-Type': 'string',
'Authorization': 'string',
'concur-correlationid': 'string'
}
r = requests.get('https://www.concursolutions.com/api/v4.0/purchaserequest/v4/purchaserequests/{id}?mode=COMPACT', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Content-Type' => 'string',
'Authorization' => 'string',
'concur-correlationid' => 'string',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://www.concursolutions.com/api/v4.0/purchaserequest/v4/purchaserequests/{id}?mode=COMPACT', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://www.concursolutions.com/api/v4.0/purchaserequest/v4/purchaserequests/{id}?mode=COMPACT");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Content-Type": []string{"string"},
"Authorization": []string{"string"},
"concur-correlationid": []string{"string"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://www.concursolutions.com/api/v4.0/purchaserequest/v4/purchaserequests/{id}?mode=COMPACT", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /purchaserequest/v4/purchaserequests/{id}?mode=COMPACT
Gets details of an existing purchase request
Gets purchase request details. The supported mode is COMPACT, which returns basic info about the purchase request along with any exceptions.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Content-Type | header | string | true | Content Type. |
| Authorization | header | string | true | Bearer Token that identifies the caller. This is the Company or User access token. |
| concur-correlationid | header | string | false | Concur specific custom header used for technical support in the form of a RFC 4122 A Universally Unique IDentifier (UUID) URN Namespace. |
| id | path | string | true | The identifier for the purchase request. |
| mode | parameter | string | true | Specifies mode for Get Purchase Request Details. Supported value: COMPACT. |
Example responses
200 Response
{
"purchaseRequestId": "string",
"purchaseRequestNumber": "string",
"purchaseRequestQueueStatus": "string",
"purchaseRequestWorkflowStatus": "string",
"purchaseOrders": {
"purchaseOrderNumber": "string"
},
"purchaseRequestExceptions": {
"eventCode": "string",
"exceptionCode": "string",
"isCleared": "string",
"prExceptionId": "string",
"message": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | getPurchaseRequestCompact |
| 401 | Unauthorized | Unauthorized | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
| 503 | Service Unavailable | Service Unavailable | None |
Schemas
purchaseRequest
{
"description": "string",
"userId": "string",
"userEmail": "string",
"userLoginId": "string",
"policyExternalId": "string",
"currencyCode": "string",
"notesToSupplier": "string",
"comments": "string",
"custom1": "string",
"custom2": "string",
"custom3": "string",
"custom4": "string",
"custom5": "string",
"custom6": "string",
"custom7": "string",
"custom8": "string",
"custom9": "string",
"custom10": "string",
"custom11": "string",
"custom12": "string",
"custom13": "string",
"custom14": "string",
"custom15": "string",
"custom16": "string",
"custom17": "string",
"custom18": "string",
"custom19": "string",
"custom20": "string",
"custom21": "string",
"custom22": "string",
"custom23": "string",
"custom24": "string",
"shipToAddressCode": "string",
"billToAddressCode": "string",
"lineItems": {
"purchaseType": "string",
"vendorCode": "string",
"vendorAddressCode": "string",
"description": "string",
"quantity": "string",
"unitPrice": "string",
"expenseType": "string",
"receiptType": "string",
"neededByDate": null,
"uoMCode": "string",
"shipping": "string",
"tax": "string",
"supplierPartId": "string",
"url": "string",
"notesToVendor": "string",
"comments": "string",
"custom1": "string",
"custom2": "string",
"custom3": "string",
"custom4": "string",
"custom5": "string",
"custom6": "string",
"custom7": "string",
"custom8": "string",
"custom9": "string",
"custom10": "string",
"custom11": "string",
"custom12": "string",
"custom13": "string",
"custom14": "string",
"custom15": "string",
"custom16": "string",
"custom17": "string",
"custom18": "string",
"custom19": "string",
"custom20": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description | string | false | none | A description of the purchase request. |
| userId | string | true | none | The employee that is requesting the items. This is the UUID of the employee. Either UserId or UserEmail or UserLoginId is required to identify the employee. |
| userEmail | string | true | none | The employee that is requesting the items. This is the employee’s email. Either UserId or UserEmail or UserLoginId is required to identify the employee. |
| userLoginId | string | true | none | The employee that is requesting the items. This is the employee’s Login Id. Either UserId or UserEmail or UserLoginId is required to identify the employee. |
| policyExternalId | string | false | none | The external identifier of the policy that should be associated with the purchase request. If not supplied, the API will use the default policy set up for the user group assigned to the requesting employee. This is the External Id from the Invoice Policy configuration. Clients will need to get these Ids from their SAP Concur contact if they need to assign policies other than the group default. |
| currencyCode | string | true | none | The 3-letter ISO 4217 currency code of the currency that is associated with the purchase request. This code will be used for all items on this request. Example: USD. |
| notesToSupplier | string | false | none | Notes to print on the transmitted purchase order PDF sent to the supplier. |
| comments | string | false | none | Internal comments related to this record. |
| custom1 | string | false | none | A value that can be applied to a custom field 1 that is part of the purchase request header form. |
| custom2 | string | false | none | A value that can be applied to a custom field 2 that is part of the purchase request header form. |
| custom3 | string | false | none | A value that can be applied to a custom field 3 that is part of the purchase request header form. |
| custom4 | string | false | none | A value that can be applied to a custom field 4 that is part of the purchase request header form. |
| custom5 | string | false | none | A value that can be applied to a custom field 5 that is part of the purchase request header form. |
| custom6 | string | false | none | A value that can be applied to a custom field 6 that is part of the purchase request header form. |
| custom7 | string | false | none | A value that can be applied to a custom field 7 that is part of the purchase request header form. |
| custom8 | string | false | none | A value that can be applied to a custom field 8 that is part of the purchase request header form. |
| custom9 | string | false | none | A value that can be applied to a custom field 9 that is part of the purchase request header form. |
| custom10 | string | false | none | A value that can be applied to a custom field 10 that is part of the purchase request header form. |
| custom11 | string | false | none | A value that can be applied to a custom field 11 that is part of the purchase request header form. |
| custom12 | string | false | none | A value that can be applied to a custom field 12 that is part of the purchase request header form. |
| custom13 | string | false | none | A value that can be applied to a custom field 13 that is part of the purchase request header form. |
| custom14 | string | false | none | A value that can be applied to a custom field 14 that is part of the purchase request header form. |
| custom15 | string | false | none | A value that can be applied to a custom field 15 that is part of the purchase request header form. |
| custom16 | string | false | none | A value that can be applied to a custom field 16 that is part of the purchase request header form. |
| custom17 | string | false | none | A value that can be applied to a custom field 17 that is part of the purchase request header form. |
| custom18 | string | false | none | A value that can be applied to a custom field 18 that is part of the purchase request header form. |
| custom19 | string | false | none | A value that can be applied to a custom field 19 that is part of the purchase request header form. |
| custom20 | string | false | none | A value that can be applied to a custom field 20 that is part of the purchase request header form. |
| custom21 | string | false | none | A value that can be applied to a custom field 21 that is part of the purchase request header form. |
| custom22 | string | false | none | A value that can be applied to a custom field 22 that is part of the purchase request header form. |
| custom23 | string | false | none | A value that can be applied to a custom field 23 that is part of the purchase request header form. |
| custom24 | string | false | none | A value that can be applied to a custom field 24 that is part of the purchase request header form. |
| shipToAddressCode | string | false | none | The shipping address of the Purchase Request. The accepted value is the address code from ShipTo record. If not supplied, the API will use the requesting user’s default shipping address. |
| billToAddressCode | string | false | none | The billing address of the Purchase Request to be used for invoicing. The accepted value is the address code from the BillTo record. If not supplied the API will use the policy’s default BillTo address. |
| lineItems | lineItem | true | none | Requested items or services related to this Purchase Request. |
lineItem
{
"purchaseType": "string",
"vendorCode": "string",
"vendorAddressCode": "string",
"description": "string",
"quantity": "string",
"unitPrice": "string",
"expenseType": "string",
"receiptType": "string",
"neededByDate": null,
"uoMCode": "string",
"shipping": "string",
"tax": "string",
"supplierPartId": "string",
"url": "string",
"notesToVendor": "string",
"comments": "string",
"custom1": "string",
"custom2": "string",
"custom3": "string",
"custom4": "string",
"custom5": "string",
"custom6": "string",
"custom7": "string",
"custom8": "string",
"custom9": "string",
"custom10": "string",
"custom11": "string",
"custom12": "string",
"custom13": "string",
"custom14": "string",
"custom15": "string",
"custom16": "string",
"custom17": "string",
"custom18": "string",
"custom19": "string",
"custom20": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| purchaseType | string | true | none | The type of item, either goods or services. Displayed as Type in Concur Invoice. Supported values: GOODS, SERVICES. |
| vendorCode | string | true | none | The code that identifies the vendor. This value can be found in the vendor information form of Vendor Manager. This is used along with Vendor Address Code to determine the specific Vendor record. |
| vendorAddressCode | string | true | none | The code that identifies the vendor’s address. This value can be found in the vendor information form of Vendor Manager and is labeled Address Accounting Code. This is used along with Vendor Code to determine the specific Vendor record. |
| description | string | true | none | A description of the line item. |
| quantity | string | true | none | The quantity associated with the line item. |
| unitPrice | string | true | none | The unit price of the line item. |
| expenseType | string | false | none | The PET code of the Expense Type that will be assigned to the line item. If not supplied it will default to the Expense Type set up on the Vendor Profile used for the item. Clients will need to get these PET codes from their SAP Concur contact. |
| receiptType | string | false | none | The type of receipt. If not supplied, the API will use the purchaseType to set this field to NONE for SERVICES, or QUANTITY_RECEIPT for GOODS. If you are using SAP Concur Receiving and need to enter Goods Receipts against the resulting PO lines use QUANTITY_RECEIPT. Supported values: QUANTITY_RECEIPT, NONE. |
| neededByDate | date | false | none | The date by which the purchase order must be fulfilled in format YYYY-MM-DD. Example: 2018-03-23. |
| uoMCode | string | false | none | Unit of Measure (UOM) code for the purchase request item. Accepted values are the UOM Codes set up in the Unit of Measure configuration in Concur Invoice. If not supplied, the API will default a UOM based on the defaults for goods and services. |
| shipping | string | false | none | The total shipping cost for the item. |
| tax | string | false | none | Tax amount that is associated with the line item. |
| supplierPartId | string | false | none | An Id value that helps to identify the line item. This could be a value such as the vendor’s part number or the manufacturer number. |
| url | string | false | none | A URL related to the item. You can have multiple URLs per item, enclosed in quotes and comma separated. |
| notesToVendor | string | false | none | Notes related to the item that display on the transmitted purchase order PDF to the vendor. |
| comments | string | false | none | Internal comments related to this record. |
| custom1 | string | false | none | A value that can be applied to a custom field 1 that is part of the purchase request line item form. |
| custom2 | string | false | none | A value that can be applied to a custom field 2 that is part of the purchase request line item form. |
| custom3 | string | false | none | A value that can be applied to a custom field 3 that is part of the purchase request line item form. |
| custom4 | string | false | none | A value that can be applied to a custom field 4 that is part of the purchase request line item form. |
| custom5 | string | false | none | A value that can be applied to a custom field 5 that is part of the purchase request line item form. |
| custom6 | string | false | none | A value that can be applied to a custom field 6 that is part of the purchase request line item form. |
| custom7 | string | false | none | A value that can be applied to a custom field 7 that is part of the purchase request line item form. |
| custom8 | string | false | none | A value that can be applied to a custom field 8 that is part of the purchase request line item form. |
| custom9 | string | false | none | A value that can be applied to a custom field 9 that is part of the purchase request line item form. |
| custom10 | string | false | none | A value that can be applied to a custom field 10 that is part of the purchase request line item form. |
| custom11 | string | false | none | A value that can be applied to a custom field 11 that is part of the purchase request line item form. |
| custom12 | string | false | none | A value that can be applied to a custom field 12 that is part of the purchase request line item form. |
| custom13 | string | false | none | A value that can be applied to a custom field 13 that is part of the purchase request line item form. |
| custom14 | string | false | none | A value that can be applied to a custom field 14 that is part of the purchase request line item form. |
| custom15 | string | false | none | A value that can be applied to a custom field 15 that is part of the purchase request line item form. |
| custom16 | string | false | none | A value that can be applied to a custom field 16 that is part of the purchase request line item form. |
| custom17 | string | false | none | A value that can be applied to a custom field 17 that is part of the purchase request line item form. |
| custom18 | string | false | none | A value that can be applied to a custom field 18 that is part of the purchase request line item form. |
| custom19 | string | false | none | A value that can be applied to a custom field 19 that is part of the purchase request line item form. |
| custom20 | string | false | none | A value that can be applied to a custom field 20 that is part of the purchase request line item form. |
purchaseRequestResponse
{
"id": "string",
"uri": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | false | none | The unique purchase request reference ID if the request has passed all validations. This reference ID will be needed to look up details of the purchase request. |
| uri | string | false | none | The URI to look up details of the newly created purchase request. |
errors
{
"error": {
"errorCode": "string",
"errorMessage": "string",
"dataPath": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| error | error | false | none | An array of errors indicating which fields have failed validation. |
error
{
"errorCode": "string",
"errorMessage": "string",
"dataPath": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| errorCode | string | false | none | An error code indicating why a field failed validation. |
| errorMessage | string | false | none | A description of the error. |
| dataPath | string | false | none | The path to the request data which has the error message. |
getPurchaseRequestCompact
{
"purchaseRequestId": "string",
"purchaseRequestNumber": "string",
"purchaseRequestQueueStatus": "string",
"purchaseRequestWorkflowStatus": "string",
"purchaseOrders": {
"purchaseOrderNumber": "string"
},
"purchaseRequestExceptions": {
"eventCode": "string",
"exceptionCode": "string",
"isCleared": "string",
"prExceptionId": "string",
"message": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| purchaseRequestId | string | false | none | The unique purchase request reference Id. Returned by the Create Purchase Request API call. |
| purchaseRequestNumber | string | false | none | The unique purchase request identifier which can be used to uniquely identify a purchase request in SAP Concur products. |
| purchaseRequestQueueStatus | string | false | none | The creation status of the purchase request. Possible values are: PENDING_CREATION, CREATED, CREATE_FAILED. |
| purchaseRequestWorkflowStatus | string | false | none | The workflow status of the purchase request. Possible values are: Approved, Pending Approval, Pending Cost Object Approval, Sent Back To Employee, Not Submitted, Submitted, Pending Processor Review, Vendor Approval, Approval Time Expired. |
| purchaseOrders | purchaseOrder | false | none | If the purchase request has been approved and a purchase order generated, this array contains the purchase order details. If empty, this element will not be returned. |
| purchaseRequestExceptions | purchaseRequestException | false | none | An array of exceptions, if present on the purchase request. If empty, this element will not be returned. |
purchaseOrder
{
"purchaseOrderNumber": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| purchaseOrderNumber | string | false | none | The purchase order number. |
purchaseRequestException
{
"eventCode": "string",
"exceptionCode": "string",
"isCleared": "string",
"prExceptionId": "string",
"message": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| eventCode | string | false | none | The event code of the exception. Example: PURCH_DETAIL_SUBMIT. |
| exceptionCode | string | false | none | The unique exception code. |
| isCleared | string | false | none | Whether the exception has been cleared. |
| prExceptionId | string | false | none | The unique exception id of the purchase request. |
| message | string | false | none | The message of the exception with details. |
Quick Expenses v4.0.3
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Base URLs:
Resources
createQuickExpenseUsingPOST_1
Code samples
# You can also use wget
curl -X POST https://us.api.concursolutions.com/quickexpense/v4/users/{userID}/context/{contextType}/quickexpenses \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'concur-correlationid: string' \
-H 'accept-language: string'
POST https://us.api.concursolutions.com/quickexpense/v4/users/{userID}/context/{contextType}/quickexpenses HTTP/1.1
Host: us.api.concursolutions.com
Content-Type: application/json
Accept: application/json
concur-correlationid: string
accept-language: string
const inputBody = '{
"comment": "string",
"entryDetails": "string",
"expenseTypeId": "string",
"location": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"id": "string",
"name": "string"
},
"paymentTypeId": "CASHX",
"transactionAmount": {
"currencyCode": "string",
"value": 0
},
"transactionDate": "2019-08-24",
"vendor": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'concur-correlationid':'string',
'accept-language':'string'
};
fetch('https://us.api.concursolutions.com/quickexpense/v4/users/{userID}/context/{contextType}/quickexpenses',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'concur-correlationid' => 'string',
'accept-language' => 'string'
}
result = RestClient.post 'https://us.api.concursolutions.com/quickexpense/v4/users/{userID}/context/{contextType}/quickexpenses',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'concur-correlationid': 'string',
'accept-language': 'string'
}
r = requests.post('https://us.api.concursolutions.com/quickexpense/v4/users/{userID}/context/{contextType}/quickexpenses', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'concur-correlationid' => 'string',
'accept-language' => 'string',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://us.api.concursolutions.com/quickexpense/v4/users/{userID}/context/{contextType}/quickexpenses', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://us.api.concursolutions.com/quickexpense/v4/users/{userID}/context/{contextType}/quickexpenses");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"concur-correlationid": []string{"string"},
"accept-language": []string{"string"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://us.api.concursolutions.com/quickexpense/v4/users/{userID}/context/{contextType}/quickexpenses", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /quickexpense/v4/users/{userID}/context/{contextType}/quickexpenses
This API is used to create a quick expense. This API does not support image creation.
This API creates a basic expense with minimal fields. Can be added to expense reports from within SAP Concur.
Body parameter
{
"comment": "string",
"entryDetails": "string",
"expenseTypeId": "string",
"location": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"id": "string",
"name": "string"
},
"paymentTypeId": "CASHX",
"transactionAmount": {
"currencyCode": "string",
"value": 0
},
"transactionDate": "2019-08-24",
"vendor": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| concur-correlationid | header | string | false | A SAP Concur specific custom header used for technical support. |
| accept-language | header | string | false | The unique identifier of the user's locale that indicates the language in which the API response should be formulated. |
| userId | path | string | true | The unique identifier of the SAP Concur user. |
| contextType | path | string | true | The access level of the SAP Concur user, which determines the form fields they can view/modify. Supported value: TRAVELER. |
| body | body | QuickExpenseRequest | false | quickExpenseRequest |
Enumerated Values
| Parameter | Value |
|---|---|
| contextType | TRAVELER |
Example responses
200 Response
{
"quickExpenseIdUri": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | NewQuickExpenseResponse |
| 201 | Created | Sucessfully created new quick expense | NewQuickExpenseResponse |
| 400 | Bad Request | Bad Request | ErrorMessage |
| 403 | Forbidden | User doesn't have appropriate roles to create quick expense | ErrorMessage |
| 500 | Internal Server Error | Internal Server Error | ErrorMessage |
createQuickExpenseUsingPOST
Code samples
# You can also use wget
curl -X POST https://us.api.concursolutions.com/quickexpense/v4/users/{userID}/context/{contextType}/quickexpenses/image \
-H 'Content-Type: multipart/form-data' \
-H 'Accept: application/json' \
-H 'concur-correlationid: string' \
-H 'accept-language: string'
POST https://us.api.concursolutions.com/quickexpense/v4/users/{userID}/context/{contextType}/quickexpenses/image HTTP/1.1
Host: us.api.concursolutions.com
Content-Type: multipart/form-data
Accept: application/json
concur-correlationid: string
accept-language: string
const inputBody = '{
"quickExpenseRequest": "string",
"fileContent": "string"
}';
const headers = {
'Content-Type':'multipart/form-data',
'Accept':'application/json',
'concur-correlationid':'string',
'accept-language':'string'
};
fetch('https://us.api.concursolutions.com/quickexpense/v4/users/{userID}/context/{contextType}/quickexpenses/image',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json',
'concur-correlationid' => 'string',
'accept-language' => 'string'
}
result = RestClient.post 'https://us.api.concursolutions.com/quickexpense/v4/users/{userID}/context/{contextType}/quickexpenses/image',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'multipart/form-data',
'Accept': 'application/json',
'concur-correlationid': 'string',
'accept-language': 'string'
}
r = requests.post('https://us.api.concursolutions.com/quickexpense/v4/users/{userID}/context/{contextType}/quickexpenses/image', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json',
'concur-correlationid' => 'string',
'accept-language' => 'string',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://us.api.concursolutions.com/quickexpense/v4/users/{userID}/context/{contextType}/quickexpenses/image', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://us.api.concursolutions.com/quickexpense/v4/users/{userID}/context/{contextType}/quickexpenses/image");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"multipart/form-data"},
"Accept": []string{"application/json"},
"concur-correlationid": []string{"string"},
"accept-language": []string{"string"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://us.api.concursolutions.com/quickexpense/v4/users/{userID}/context/{contextType}/quickexpenses/image", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /quickexpense/v4/users/{userID}/context/{contextType}/quickexpenses/image
This API is used to create a quick expense with image. An image is required. This API accepts multipart/form-data request.
This API creates a new quick expense and attaches an image to it, which is provided with multipart/form-data request.
Body parameter
quickExpenseRequest: string
fileContent: string
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| concur-correlationid | header | string | false | A SAP Concur specific custom header used for technical support. |
| accept-language | header | string | false | The unique identifier of the user's locale that indicates the language in which the API response should be formulated. |
| userId | path | string | true | The unique identifier of the SAP Concur user. |
| contextType | path | string | true | The access level of the SAP Concur user, which determines the form fields they can view/modify. Supported value: TRAVELER. |
| body | body | object | false | none |
| » quickExpenseRequest | body | string | false | QuickExpenseRequest { comment (string, optional): This is a comment attached to the quick expense. , entryDetails (string, optional): The quick expense entry details. , expenseTypeId (string, optional): This is the expense type id of the quick expense. , location (Location): The location where the quick expense occurred. , paymentTypeId (string, optional): This is the payment type id of the quick expense. , transactionAmount (Amount): The amount of the quick expense. , transactionDate (string): This is the transaction date of the quick expense. Format: YYYY-MM-DD , vendor (string, optional): The name of the vendor. , Location { city (string, optional): The location city. , countryCode (string, optional): The location country ISO 3166-1 code. , countrySubDivisionCode (string, optional): The location country sub division ISO 3166-2 code. , id (string, optional): The unique identifier of the location. , name (string, optional): The location name. } Amount { currencyCode (string): The 3-letter ISO 4217 currency code for the amount. , value (number): The amount value. } |
| » fileContent | body | string(binary) | true | Image file. Supported image file type ['PNG','GIF','PDF','TIFF','JPEG']. Max image size supported - 5MB |
Enumerated Values
| Parameter | Value |
|---|---|
| contextType | TRAVELER |
Example responses
200 Response
{
"quickExpenseIdUri": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | NewQuickExpenseResponse |
| 201 | Created | Sucessfully created new quick expense | NewQuickExpenseResponse |
| 400 | Bad Request | Bad Request | ErrorMessage |
| 403 | Forbidden | User doesn't have appropriate roles to create quick expense | ErrorMessage |
| 500 | Internal Server Error | Internal Server Error | ErrorMessage |
Schemas
URI
{
"absolute": true,
"authority": "string",
"fragment": "string",
"host": "string",
"opaque": true,
"path": "string",
"port": 0,
"query": "string",
"rawAuthority": "string",
"rawFragment": "string",
"rawPath": "string",
"rawQuery": "string",
"rawSchemeSpecificPart": "string",
"rawUserInfo": "string",
"scheme": "string",
"schemeSpecificPart": "string",
"userInfo": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| absolute | boolean | false | none | none |
| authority | string | false | none | none |
| fragment | string | false | none | none |
| host | string | false | none | none |
| opaque | boolean | false | none | none |
| path | string | false | none | none |
| port | integer(int32) | false | none | none |
| query | string | false | none | none |
| rawAuthority | string | false | none | none |
| rawFragment | string | false | none | none |
| rawPath | string | false | none | none |
| rawQuery | string | false | none | none |
| rawSchemeSpecificPart | string | false | none | none |
| rawUserInfo | string | false | none | none |
| scheme | string | false | none | none |
| schemeSpecificPart | string | false | none | none |
| userInfo | string | false | none | none |
NewQuickExpenseResponse
{
"quickExpenseIdUri": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| quickExpenseIdUri | string | false | none | The quick expense created resource url. |
URL
{
"authority": "string",
"content": {},
"defaultPort": 0,
"deserializedFields": {},
"file": "string",
"host": "string",
"path": "string",
"port": 0,
"protocol": "string",
"query": "string",
"ref": "string",
"serializedHashCode": 0,
"userInfo": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| authority | string | false | none | none |
| content | object | false | none | none |
| defaultPort | integer(int32) | false | none | none |
| deserializedFields | URLStreamHandler | false | none | none |
| file | string | false | none | none |
| host | string | false | none | none |
| path | string | false | none | none |
| port | integer(int32) | false | none | none |
| protocol | string | false | none | none |
| query | string | false | none | none |
| ref | string | false | none | none |
| serializedHashCode | integer(int32) | false | none | none |
| userInfo | string | false | none | none |
MultipartFile
{
"bytes": [
"string"
],
"contentType": "string",
"empty": true,
"inputStream": {},
"name": "string",
"originalFilename": "string",
"resource": {
"description": "string",
"file": null,
"filename": "string",
"inputStream": {},
"open": true,
"readable": true,
"uri": {
"absolute": true,
"authority": "string",
"fragment": "string",
"host": "string",
"opaque": true,
"path": "string",
"port": 0,
"query": "string",
"rawAuthority": "string",
"rawFragment": "string",
"rawPath": "string",
"rawQuery": "string",
"rawSchemeSpecificPart": "string",
"rawUserInfo": "string",
"scheme": "string",
"schemeSpecificPart": "string",
"userInfo": "string"
},
"url": {
"authority": "string",
"content": {},
"defaultPort": 0,
"deserializedFields": {},
"file": "string",
"host": "string",
"path": "string",
"port": 0,
"protocol": "string",
"query": "string",
"ref": "string",
"serializedHashCode": 0,
"userInfo": "string"
}
},
"size": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| bytes | [string] | false | none | none |
| contentType | string | false | none | none |
| empty | boolean | false | none | none |
| inputStream | InputStream | false | none | none |
| name | string | false | none | none |
| originalFilename | string | false | none | none |
| resource | Resource | false | none | none |
| size | integer(int64) | false | none | none |
PaymentType
{
"code": "string",
"id": "string",
"name": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| code | string | true | none | The payment type code. |
| id | string | true | none | The unique identifier of the payment type. |
| name | string | true | none | The name of the payment type, localized to the user's language. |
InputStream
{}
Properties
None
Amount
{
"currencyCode": "string",
"value": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| currencyCode | string | true | none | The 3-letter ISO 4217 currency code for the amount. |
| value | number(double) | true | none | The amount value. |
Resource
{
"description": "string",
"file": null,
"filename": "string",
"inputStream": {},
"open": true,
"readable": true,
"uri": {
"absolute": true,
"authority": "string",
"fragment": "string",
"host": "string",
"opaque": true,
"path": "string",
"port": 0,
"query": "string",
"rawAuthority": "string",
"rawFragment": "string",
"rawPath": "string",
"rawQuery": "string",
"rawSchemeSpecificPart": "string",
"rawUserInfo": "string",
"scheme": "string",
"schemeSpecificPart": "string",
"userInfo": "string"
},
"url": {
"authority": "string",
"content": {},
"defaultPort": 0,
"deserializedFields": {},
"file": "string",
"host": "string",
"path": "string",
"port": 0,
"protocol": "string",
"query": "string",
"ref": "string",
"serializedHashCode": 0,
"userInfo": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description | string | false | none | none |
| file | file | false | none | none |
| filename | string | false | none | none |
| inputStream | InputStream | false | none | none |
| open | boolean | false | none | none |
| readable | boolean | false | none | none |
| uri | URI | false | none | none |
| url | URL | false | none | none |
ExpenseType
{
"code": "string",
"id": "string",
"name": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| code | string | true | none | The expense type code. |
| id | string | true | none | The unique identifier of the expense type. |
| name | string | true | none | The name of the expense type, localized to the user's language. |
QuickExpenseRequest
{
"comment": "string",
"entryDetails": "string",
"expenseTypeId": "string",
"location": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"id": "string",
"name": "string"
},
"paymentTypeId": "CASHX",
"transactionAmount": {
"currencyCode": "string",
"value": 0
},
"transactionDate": "2019-08-24",
"vendor": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| comment | string | false | none | This is a comment attached to the quick expense. |
| entryDetails | string | false | none | The quick expense entry details. |
| expenseTypeId | string | false | none | This is the expense type id of the quick expense. |
| location | Location | true | none | The location where the quick expense occurred. |
| paymentTypeId | string | false | none | This is the payment type id of the quick expense. |
| transactionAmount | Amount | true | none | The amount of the quick expense. |
| transactionDate | string(date) | true | none | This is the transaction date of the quick expense. Format: YYYY-MM-DD |
| vendor | string | false | none | The name of the vendor. |
Enumerated Values
| Property | Value |
|---|---|
| paymentTypeId | CASHX |
| paymentTypeId | CPAID |
| paymentTypeId | PENDC |
UriResponse
{
"uri": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| uri | string | true | none | URI of the created resource. |
Date
{
"date": 0,
"day": 0,
"hours": 0,
"minutes": 0,
"month": 0,
"seconds": 0,
"time": 0,
"timezoneOffset": 0,
"year": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| date | integer(int32) | false | none | none |
| day | integer(int32) | false | none | none |
| hours | integer(int32) | false | none | none |
| minutes | integer(int32) | false | none | none |
| month | integer(int32) | false | none | none |
| seconds | integer(int32) | false | none | none |
| time | integer(int64) | false | none | none |
| timezoneOffset | integer(int32) | false | none | none |
| year | integer(int32) | false | none | none |
URLStreamHandler
{}
Properties
None
ErrorMessage
{
"errorId": "string",
"errorMessage": "string",
"httpStatus": "string",
"path": "string",
"timestamp": "2016-10-04T00:53:25.931+0000",
"validationErrors": []
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| errorId | string | false | none | The unique identifier of the error. |
| errorMessage | string | true | none | Message associated with the error. |
| httpStatus | string | true | none | The HTTP status associated with the error. |
| path | string | true | none | The path to the resource. |
| timestamp | string(date-time) | true | none | The timestamp for the error. |
| validationErrors | [ValidationError] | false | none | An array of validation errors. |
File
{
"absolute": true,
"absolutePath": "string",
"canonicalPath": "string",
"directory": true,
"executable": true,
"file": true,
"freeSpace": 0,
"hidden": true,
"lastModified": 0,
"name": "string",
"parent": "string",
"path": "string",
"readable": true,
"totalSpace": 0,
"usableSpace": 0,
"writable": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| absolute | boolean | false | none | none |
| absolutePath | string | false | none | none |
| canonicalPath | string | false | none | none |
| directory | boolean | false | none | none |
| executable | boolean | false | none | none |
| file | boolean | false | none | none |
| freeSpace | integer(int64) | false | none | none |
| hidden | boolean | false | none | none |
| lastModified | integer(int64) | false | none | none |
| name | string | false | none | none |
| parent | string | false | none | none |
| path | string | false | none | none |
| readable | boolean | false | none | none |
| totalSpace | integer(int64) | false | none | none |
| usableSpace | integer(int64) | false | none | none |
| writable | boolean | false | none | none |
Link
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": true,
"title": "string",
"type": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| deprecation | string | false | none | none |
| href | string | false | none | none |
| hreflang | string | false | none | none |
| media | string | false | none | none |
| rel | string | false | none | none |
| templated | boolean | false | none | none |
| title | string | false | none | none |
| type | string | false | none | none |
Location
{
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"id": "string",
"name": "string"
}
This represents the location.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| city | string | false | none | The location city. |
| countryCode | string | false | none | The location country ISO 3166-1 code. |
| countrySubDivisionCode | string | false | none | The location country sub division ISO 3166-2 code. |
| id | string | false | none | The unique identifier of the location. |
| name | string | false | none | The location name. |
Collection_object_
{}
Properties
None
Request v4.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Request as a Service
Base URLs:
Request Resource
Represents the starting point of pre-spend authorizations within Concur Request
getListUsingGET
Code samples
# You can also use wget
curl -X GET /us.api.concursolutions.com/travelrequest/v4/requests \
-H 'Accept: application/json'
GET /us.api.concursolutions.com/travelrequest/v4/requests HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('/us.api.concursolutions.com/travelrequest/v4/requests',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get '/us.api.concursolutions.com/travelrequest/v4/requests',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('/us.api.concursolutions.com/travelrequest/v4/requests', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/us.api.concursolutions.com/travelrequest/v4/requests', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/us.api.concursolutions.com/travelrequest/v4/requests");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/us.api.concursolutions.com/travelrequest/v4/requests", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /requests
Get the list of existing Requests
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| view | query | string | false | Name of the perimeter defining the Requests to get |
| userId | query | string | false | The unique identifier of the Request owner to use when searching for Requests |
| limit | query | string | false | Pagination : number of records to return per page - maximum limit is 100, if higher value or digit value is set, a 400 error code will be displayed |
| start | query | string | false | Pagination : index of the first record |
| modifiedAfter | query | string(date-time) | false | Lower bound of modification date. Format: yyyy-MM-ddTHH:mm:ss.SSSZ or yyyy-MM-dd |
| modifiedBefore | query | string(date-time) | false | Upper bound of modification date. Format: yyyy-MM-ddTHH:mm:ss.SSSZ or yyyy-MM-dd |
| sortField | query | string | false | The name of the field on which to sort |
| sortOrder | query | string | false | Sort order (ASC or DESC) |
| approvedAfter | query | string(date-time) | false | Lower bound of approval date. Format: yyyy-MM-ddTHH:mm:ss |
| approvedBefore | query | string(date-time) | false | Upper bound of approval date. Format: yyyy-MM-ddTHH:mm:ss |
Enumerated Values
| Parameter | Value |
|---|---|
| view | ALL |
| view | ACTIVE |
| view | UNSUBMITTED |
| view | PENDING |
| view | VALIDATED |
| view | APPROVED |
| view | CANCELED |
| view | CLOSED |
| view | SUBMITTED |
| view | TOAPPROVE |
| view | PENDINGPROPOSAL |
| view | PROPOSALAPPROVED |
| view | PROPOSALCANCELED |
| view | PENDINGEBOOKING |
| sortField | startDate |
| sortField | approvalStatus |
| sortField | requestId |
| sortOrder | ASC |
| sortOrder | DESC |
Example responses
200 Response
{
"data": [
{
"approvalLimitDate": "string",
"approvalStatus": {
"code": "APPROVED",
"name": "string"
},
"approved": true,
"approver": {
"firstName": "string",
"middleInitial": "string",
"href": "string",
"id": "string",
"lastName": "string",
"template": "string"
},
"authorizedDate": "string",
"businessPurpose": "string",
"canceledPostApproval": true,
"closed": false,
"comment": "string",
"comments": {
"href": "string",
"id": "string",
"template": "string"
},
"creationDate": "string",
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"endDate": "string",
"endTime": "string",
"everSentBack": false,
"expenses": [
{
"href": "string",
"id": "string",
"template": "string"
}
],
"extensionOf": {
"requestId": "string"
},
"highestExceptionLevel": "NONE",
"href": "string",
"id": "string",
"lastModified": "string",
"mainDestination": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"name": "string",
"operations": [
{
"href": "string",
"rel": "string"
}
],
"owner": {
"firstName": "string",
"middleInitial": "string",
"href": "string",
"id": "string",
"lastName": "string",
"template": "string"
},
"pendingApproval": true,
"policy": {
"href": "string",
"id": "string",
"template": "string"
},
"requestId": "string",
"startDate": "string",
"startTime": "string",
"submitDate": "string",
"totalApprovedAmount": {
"currency": "string",
"value": 1
},
"totalPostedAmount": {
"currency": "string",
"value": 1
},
"totalRemainingAmount": {
"currency": "string",
"value": 1
},
"travelAgency": {
"href": "string",
"id": "string",
"template": "string"
},
"type": {
"code": "string",
"label": "string"
}
}
],
"operations": [
{
"href": "string",
"rel": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | PageResultOfResourceOfRequest |
| 400 | Bad Request | Bad param(s) : the request is invalid | ErrorResponse |
| 401 | Unauthorized | Invalid or nonexistent authorization HTTP header | ErrorResponse |
| 403 | Forbidden | Permission Denied | ErrorResponse |
| 404 | Not Found | Not found | ErrorResponse |
| 408 | Request Timeout | Time out | ErrorResponse |
| 500 | Internal Server Error | Internal server error | ErrorResponse |
| 503 | Service Unavailable | The service is currently unavailable | ErrorResponse |
createUsingPOST_4
Code samples
# You can also use wget
curl -X POST /us.api.concursolutions.com/travelrequest/v4/requests \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
POST /us.api.concursolutions.com/travelrequest/v4/requests HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"approvalLimitDate": "string",
"approvalStatus": {
"code": "APPROVED",
"name": "string"
},
"approved": true,
"approver": {
"firstName": "string",
"middleInitial": "string",
"href": "string",
"id": "string",
"lastName": "string",
"template": "string"
},
"authorizedDate": "string",
"businessPurpose": "string",
"canceledPostApproval": true,
"closed": false,
"comment": "string",
"comments": {
"href": "string",
"id": "string",
"template": "string"
},
"creationDate": "string",
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"endDate": "string",
"endTime": "string",
"everSentBack": false,
"expenses": [
{
"href": "string",
"id": "string",
"template": "string"
}
],
"extensionOf": {
"requestId": "string"
},
"highestExceptionLevel": "NONE",
"href": "string",
"id": "string",
"lastModified": "string",
"mainDestination": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"name": "string",
"operations": [
{
"href": "string",
"rel": "string"
}
],
"owner": {
"firstName": "string",
"middleInitial": "string",
"href": "string",
"id": "string",
"lastName": "string",
"template": "string"
},
"pendingApproval": true,
"policy": {
"href": "string",
"id": "string",
"template": "string"
},
"requestId": "string",
"startDate": "string",
"startTime": "string",
"submitDate": "string",
"totalApprovedAmount": {
"currency": "string",
"value": 1
},
"totalPostedAmount": {
"currency": "string",
"value": 1
},
"totalRemainingAmount": {
"currency": "string",
"value": 1
},
"travelAgency": {
"href": "string",
"id": "string",
"template": "string"
},
"type": {
"code": "string",
"label": "string"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('/us.api.concursolutions.com/travelrequest/v4/requests',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post '/us.api.concursolutions.com/travelrequest/v4/requests',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('/us.api.concursolutions.com/travelrequest/v4/requests', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/us.api.concursolutions.com/travelrequest/v4/requests', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/us.api.concursolutions.com/travelrequest/v4/requests");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/us.api.concursolutions.com/travelrequest/v4/requests", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /requests
Create a new Request
Body parameter
{
"approvalLimitDate": "string",
"approvalStatus": {
"code": "APPROVED",
"name": "string"
},
"approved": true,
"approver": {
"firstName": "string",
"middleInitial": "string",
"href": "string",
"id": "string",
"lastName": "string",
"template": "string"
},
"authorizedDate": "string",
"businessPurpose": "string",
"canceledPostApproval": true,
"closed": false,
"comment": "string",
"comments": {
"href": "string",
"id": "string",
"template": "string"
},
"creationDate": "string",
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"endDate": "string",
"endTime": "string",
"everSentBack": false,
"expenses": [
{
"href": "string",
"id": "string",
"template": "string"
}
],
"extensionOf": {
"requestId": "string"
},
"highestExceptionLevel": "NONE",
"href": "string",
"id": "string",
"lastModified": "string",
"mainDestination": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"name": "string",
"operations": [
{
"href": "string",
"rel": "string"
}
],
"owner": {
"firstName": "string",
"middleInitial": "string",
"href": "string",
"id": "string",
"lastName": "string",
"template": "string"
},
"pendingApproval": true,
"policy": {
"href": "string",
"id": "string",
"template": "string"
},
"requestId": "string",
"startDate": "string",
"startTime": "string",
"submitDate": "string",
"totalApprovedAmount": {
"currency": "string",
"value": 1
},
"totalPostedAmount": {
"currency": "string",
"value": 1
},
"totalRemainingAmount": {
"currency": "string",
"value": 1
},
"travelAgency": {
"href": "string",
"id": "string",
"template": "string"
},
"type": {
"code": "string",
"label": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| userId | query | string | false | The unique identifier of the Request owner for whom the Request will be created |
| body | body | Request | true | Request |
Example responses
201 Response
{
"approvalLimitDate": "string",
"approvalStatus": {
"code": "APPROVED",
"name": "string"
},
"approved": true,
"approver": {
"firstName": "string",
"middleInitial": "string",
"href": "string",
"id": "string",
"lastName": "string",
"template": "string"
},
"authorizedDate": "string",
"businessPurpose": "string",
"canceledPostApproval": true,
"closed": false,
"comment": "string",
"comments": {
"href": "string",
"id": "string",
"template": "string"
},
"creationDate": "string",
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"endDate": "string",
"endTime": "string",
"everSentBack": false,
"expenses": [
{
"href": "string",
"id": "string",
"template": "string"
}
],
"extensionOf": {
"requestId": "string"
},
"highestExceptionLevel": "NONE",
"href": "string",
"id": "string",
"lastModified": "string",
"mainDestination": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"name": "string",
"operations": [
{
"href": "string",
"rel": "string"
}
],
"owner": {
"firstName": "string",
"middleInitial": "string",
"href": "string",
"id": "string",
"lastName": "string",
"template": "string"
},
"pendingApproval": true,
"policy": {
"href": "string",
"id": "string",
"template": "string"
},
"requestId": "string",
"startDate": "string",
"startTime": "string",
"submitDate": "string",
"totalApprovedAmount": {
"currency": "string",
"value": 1
},
"totalPostedAmount": {
"currency": "string",
"value": 1
},
"totalRemainingAmount": {
"currency": "string",
"value": 1
},
"travelAgency": {
"href": "string",
"id": "string",
"template": "string"
},
"type": {
"code": "string",
"label": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Created | Request |
| 400 | Bad Request | Invalid request body | ErrorResponse |
| 401 | Unauthorized | Invalid or nonexistent authorization HTTP header | ErrorResponse |
| 403 | Forbidden | Permission Denied | ErrorResponse |
| 404 | Not Found | Not found | ErrorResponse |
| 408 | Request Timeout | Time out | ErrorResponse |
| 500 | Internal Server Error | Internal server error | ErrorResponse |
| 503 | Service Unavailable | The service is currently unavailable | ErrorResponse |
getUsingGET_6
Code samples
# You can also use wget
curl -X GET /us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid} \
-H 'Accept: application/json'
GET /us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get '/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /requests/{requestUuid}
Get the content of an existing Request
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| requestUuid | path | string | true | The unique identifier of the Request |
Example responses
200 Response
{
"approvalLimitDate": "string",
"approvalStatus": {
"code": "APPROVED",
"name": "string"
},
"approved": true,
"approver": {
"firstName": "string",
"middleInitial": "string",
"href": "string",
"id": "string",
"lastName": "string",
"template": "string"
},
"authorizedDate": "string",
"businessPurpose": "string",
"canceledPostApproval": true,
"cashAdvances": {
"href": "string",
"id": "string",
"template": "string"
},
"closed": false,
"comment": "string",
"comments": {
"href": "string",
"id": "string",
"template": "string"
},
"creationDate": "string",
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"endDate": "string",
"endTime": "string",
"everSentBack": false,
"exceptions": {
"href": "string",
"id": "string",
"template": "string"
},
"expenses": [
{
"href": "string",
"id": "string",
"template": "string"
}
],
"extensionOf": {
"requestId": "string"
},
"highestExceptionLevel": "NONE",
"href": "string",
"id": "string",
"lastModified": "string",
"mainDestination": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"name": "string",
"operations": [
{
"href": "string",
"rel": "string"
}
],
"owner": {
"firstName": "string",
"middleInitial": "string",
"href": "string",
"id": "string",
"lastName": "string",
"template": "string"
},
"pendingApproval": true,
"policy": {
"href": "string",
"id": "string",
"template": "string"
},
"requestId": "string",
"startDate": "string",
"startTime": "string",
"submitDate": "string",
"totalApprovedAmount": {
"currency": "string",
"value": 1
},
"totalPostedAmount": {
"currency": "string",
"value": 1
},
"totalRemainingAmount": {
"currency": "string",
"value": 1
},
"travelAgency": {
"href": "string",
"id": "string",
"template": "string"
},
"type": {
"code": "string",
"label": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | RequestDetails |
| 400 | Bad Request | Bad param: invalid Guid | ErrorResponse |
| 401 | Unauthorized | Invalid or nonexistent authorization HTTP header | ErrorResponse |
| 403 | Forbidden | Permission Denied | ErrorResponse |
| 404 | Not Found | Not found | ErrorResponse |
| 408 | Request Timeout | Time out | ErrorResponse |
| 500 | Internal Server Error | Internal server error | ErrorResponse |
| 503 | Service Unavailable | The service is currently unavailable | ErrorResponse |
updateUsingPUT_2
Code samples
# You can also use wget
curl -X PUT /us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
PUT /us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"approvalLimitDate": "string",
"approvalStatus": {
"code": "APPROVED",
"name": "string"
},
"approved": true,
"approver": {
"firstName": "string",
"middleInitial": "string",
"href": "string",
"id": "string",
"lastName": "string",
"template": "string"
},
"authorizedDate": "string",
"businessPurpose": "string",
"canceledPostApproval": true,
"closed": false,
"comment": "string",
"comments": {
"href": "string",
"id": "string",
"template": "string"
},
"creationDate": "string",
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"endDate": "string",
"endTime": "string",
"everSentBack": false,
"expenses": [
{
"href": "string",
"id": "string",
"template": "string"
}
],
"extensionOf": {
"requestId": "string"
},
"highestExceptionLevel": "NONE",
"href": "string",
"id": "string",
"lastModified": "string",
"mainDestination": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"name": "string",
"operations": [
{
"href": "string",
"rel": "string"
}
],
"owner": {
"firstName": "string",
"middleInitial": "string",
"href": "string",
"id": "string",
"lastName": "string",
"template": "string"
},
"pendingApproval": true,
"policy": {
"href": "string",
"id": "string",
"template": "string"
},
"requestId": "string",
"startDate": "string",
"startTime": "string",
"submitDate": "string",
"totalApprovedAmount": {
"currency": "string",
"value": 1
},
"totalPostedAmount": {
"currency": "string",
"value": 1
},
"totalRemainingAmount": {
"currency": "string",
"value": 1
},
"travelAgency": {
"href": "string",
"id": "string",
"template": "string"
},
"type": {
"code": "string",
"label": "string"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.put '/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.put('/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /requests/{requestUuid}
Update the content of an existing Request
Body parameter
{
"approvalLimitDate": "string",
"approvalStatus": {
"code": "APPROVED",
"name": "string"
},
"approved": true,
"approver": {
"firstName": "string",
"middleInitial": "string",
"href": "string",
"id": "string",
"lastName": "string",
"template": "string"
},
"authorizedDate": "string",
"businessPurpose": "string",
"canceledPostApproval": true,
"closed": false,
"comment": "string",
"comments": {
"href": "string",
"id": "string",
"template": "string"
},
"creationDate": "string",
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"endDate": "string",
"endTime": "string",
"everSentBack": false,
"expenses": [
{
"href": "string",
"id": "string",
"template": "string"
}
],
"extensionOf": {
"requestId": "string"
},
"highestExceptionLevel": "NONE",
"href": "string",
"id": "string",
"lastModified": "string",
"mainDestination": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"name": "string",
"operations": [
{
"href": "string",
"rel": "string"
}
],
"owner": {
"firstName": "string",
"middleInitial": "string",
"href": "string",
"id": "string",
"lastName": "string",
"template": "string"
},
"pendingApproval": true,
"policy": {
"href": "string",
"id": "string",
"template": "string"
},
"requestId": "string",
"startDate": "string",
"startTime": "string",
"submitDate": "string",
"totalApprovedAmount": {
"currency": "string",
"value": 1
},
"totalPostedAmount": {
"currency": "string",
"value": 1
},
"totalRemainingAmount": {
"currency": "string",
"value": 1
},
"travelAgency": {
"href": "string",
"id": "string",
"template": "string"
},
"type": {
"code": "string",
"label": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| requestUuid | path | string | true | The unique identifier of the Request |
| userId | query | string | false | The unique identifier of the user |
| body | body | Request | true | request |
Example responses
200 Response
{
"approvalLimitDate": "string",
"approvalStatus": {
"code": "APPROVED",
"name": "string"
},
"approved": true,
"approver": {
"firstName": "string",
"middleInitial": "string",
"href": "string",
"id": "string",
"lastName": "string",
"template": "string"
},
"authorizedDate": "string",
"businessPurpose": "string",
"canceledPostApproval": true,
"closed": false,
"comment": "string",
"comments": {
"href": "string",
"id": "string",
"template": "string"
},
"creationDate": "string",
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"endDate": "string",
"endTime": "string",
"everSentBack": false,
"expenses": [
{
"href": "string",
"id": "string",
"template": "string"
}
],
"extensionOf": {
"requestId": "string"
},
"highestExceptionLevel": "NONE",
"href": "string",
"id": "string",
"lastModified": "string",
"mainDestination": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"name": "string",
"operations": [
{
"href": "string",
"rel": "string"
}
],
"owner": {
"firstName": "string",
"middleInitial": "string",
"href": "string",
"id": "string",
"lastName": "string",
"template": "string"
},
"pendingApproval": true,
"policy": {
"href": "string",
"id": "string",
"template": "string"
},
"requestId": "string",
"startDate": "string",
"startTime": "string",
"submitDate": "string",
"totalApprovedAmount": {
"currency": "string",
"value": 1
},
"totalPostedAmount": {
"currency": "string",
"value": 1
},
"totalRemainingAmount": {
"currency": "string",
"value": 1
},
"travelAgency": {
"href": "string",
"id": "string",
"template": "string"
},
"type": {
"code": "string",
"label": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Request |
| 400 | Bad Request | Bad param(s) : the request is invalid | ErrorResponse |
| 401 | Unauthorized | Invalid or nonexistent authorization HTTP header | ErrorResponse |
| 403 | Forbidden | Permission Denied | ErrorResponse |
| 404 | Not Found | Not found | ErrorResponse |
| 408 | Request Timeout | Time out | ErrorResponse |
| 500 | Internal Server Error | Internal server error | ErrorResponse |
| 503 | Service Unavailable | The service is currently unavailable | ErrorResponse |
deleteUsingDELETE_1
Code samples
# You can also use wget
curl -X DELETE /us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid} \
-H 'Accept: */*'
DELETE /us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid} HTTP/1.1
Accept: */*
const headers = {
'Accept':'*/*'
};
fetch('/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*'
}
result = RestClient.delete '/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': '*/*'
}
r = requests.delete('/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => '*/*',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /requests/{requestUuid}
Delete an existing Request
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| requestUuid | path | string | true | The unique identifier of the Request |
| userId | query | string | false | The unique identifier of the user |
Example responses
200 Response
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | boolean |
| 400 | Bad Request | Bad param: invalid Guid | ErrorResponse |
| 401 | Unauthorized | Invalid or nonexistent authorization HTTP header | ErrorResponse |
| 403 | Forbidden | Permission Denied | ErrorResponse |
| 404 | Not Found | Not found | ErrorResponse |
| 408 | Request Timeout | Time out | ErrorResponse |
| 500 | Internal Server Error | Internal server error | ErrorResponse |
| 503 | Service Unavailable | The service is currently unavailable | ErrorResponse |
getCommentsByRequestUsingGET
Code samples
# You can also use wget
curl -X GET /us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/comments \
-H 'Accept: application/json'
GET /us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/comments HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/comments',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get '/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/comments',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/comments', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/comments', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/comments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/comments", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /requests/{requestUuid}/comments
Get the list of comments for an existing Request
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| requestUuid | path | string | true | The unique identifier of the Request |
Example responses
200 Response
[
{
"author": {
"firstName": "string",
"middleInitial": "string",
"href": "string",
"id": "string",
"lastName": "string",
"template": "string"
},
"creationDateTime": "string",
"isLatest": false,
"value": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Inline |
| 400 | Bad Request | Bad param: invalid Guid | ErrorResponse |
| 401 | Unauthorized | Invalid or nonexistent authorization HTTP header | ErrorResponse |
| 403 | Forbidden | Permission Denied | ErrorResponse |
| 404 | Not Found | Not found | ErrorResponse |
| 408 | Request Timeout | Time out | ErrorResponse |
| 500 | Internal Server Error | Internal server error | ErrorResponse |
| 503 | Service Unavailable | The service is currently unavailable | ErrorResponse |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [Comment] | false | none | none |
| » author | Employee | false | none | none |
| »» firstName | string | false | none | The first name of the employee |
| »» middleInitial | string | false | none | The middle initial of the employee |
| »» href | string | false | none | Hyperlink to the resource |
| »» id | string | false | none | Unique identifier of the related object |
| »» lastName | string | false | none | The last name of the employee |
| »» template | string | false | none | Hyperlink template to the resource |
| » creationDateTime | string | false | none | Creation date of the comment (in the format YYYY-MM-DD HH:mm:ss.SSS) |
| » isLatest | boolean | false | none | True when the comment has been edited since the last workflow transition |
| » value | string | false | none | Comment value |
getCashAdvancesByRequestUsingGET
Code samples
# You can also use wget
curl -X GET /us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/cashadvances \
-H 'Accept: application/json'
GET /us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/cashadvances HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/cashadvances',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get '/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/cashadvances',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/cashadvances', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/cashadvances', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/cashadvances");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/cashadvances", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /requests/{requestUuid}/cashadvances
Get the list of cash advances assigned to an existing Request
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| requestUuid | path | string | true | The unique identifier of the Request |
Example responses
200 Response
[
{
"href": "string",
"id": "string",
"template": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Inline |
| 400 | Bad Request | Bad param: invalid Guid | ErrorResponse |
| 401 | Unauthorized | Invalid or nonexistent authorization HTTP header | ErrorResponse |
| 403 | Forbidden | You do not have permission to perform this operation | ErrorResponse |
| 404 | Not Found | Not found | ErrorResponse |
| 408 | Request Timeout | Time out | ErrorResponse |
| 500 | Internal Server Error | An unexpected error has prevented the operation | ErrorResponse |
| 503 | Service Unavailable | The service is currently unavailable | ErrorResponse |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [ResourceLink] | false | none | none |
| » href | string | false | none | Hyperlink to the resource |
| » id | string | false | none | Unique identifier of the related object |
| » template | string | false | none | Hyperlink template to the resource |
getExceptionsByRequestUsingGET
Code samples
# You can also use wget
curl -X GET /us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/exceptions \
-H 'Accept: application/json'
GET /us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/exceptions HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/exceptions',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get '/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/exceptions',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/exceptions', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/exceptions', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/exceptions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/exceptions", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /requests/{requestUuid}/exceptions
Get the list of exceptions linked to an existing Request
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| requestUuid | path | string | true | The unique identifier of the Request |
Example responses
200 Response
[
{
"code": "string",
"isBlocking": false,
"level": 0,
"message": "string",
"parameters": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"source": {
"href": "string",
"id": "string",
"type": "ALLOCATION"
}
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Inline |
| 400 | Bad Request | Bad param: invalid Guid | ErrorResponse |
| 401 | Unauthorized | Invalid or nonexistent authorization HTTP header | ErrorResponse |
| 403 | Forbidden | You do not have permission to perform this operation | ErrorResponse |
| 404 | Not Found | Not found | ErrorResponse |
| 408 | Request Timeout | Time out | ErrorResponse |
| 500 | Internal Server Error | An unexpected error has prevented the operation | ErrorResponse |
| 503 | Service Unavailable | The service is currently unavailable | ErrorResponse |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [RequestException] | false | none | none |
| » code | string | false | none | The system exception code defined for the exception. Example: BADCODE |
| » isBlocking | boolean | false | none | Defines whether the exception will prevent the Request from being submitted |
| » level | integer(int64) | false | none | The numeric level associated with the exception. Example: 99 |
| » message | string | false | none | The user-facing message defined for the exception |
| » parameters | object | false | none | Parameters for the messages of the exception |
| »» additionalProperties | [string] | false | none | none |
| » source | ExceptionSource | false | none | none |
| »» href | string | false | none | The link to the unique identifier of source. Will be empty if source is ALLOCATION or CASH_ADVANCE. |
| »» id | string | false | none | The unique identifier of the source |
| »» type | string | false | none | Defines the type of the source which can be one of "ALLOCATION", "CASH_ADVANCE", "EXPENSE", "HEADER" |
Enumerated Values
| Property | Value |
|---|---|
| type | ALLOCATION |
| type | CASH_ADVANCE |
| type | EXPENSE |
| type | HEADER |
Workflow Resource
Manage workflow transitions for a Request
workflowActionUsingPOST
Code samples
# You can also use wget
curl -X POST /us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/{action} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
POST /us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/{action} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = 'string';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/{action}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post '/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/{action}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/{action}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/{action}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/{action}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/{action}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /requests/{requestUuid}/{action}
Move an existing Request in the approval workflow
Body parameter
"string"
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| requestUuid | path | string | true | The unique identifier of the Request |
| action | path | string | true | The workflow state transition to be executed |
| companyId | query | string | false | The unique identifier of the company |
| userId | query | string | false | The unique identifier of the user performing the status transition |
| body | body | WorkflowAction | false | Only usable when the workflow action is set to ‘sendback’. |
Enumerated Values
| Parameter | Value |
|---|---|
| action | submit |
| action | approve |
| action | recall |
| action | sendback |
| action | cancel |
| action | close |
| action | reopen |
Example responses
200 Response
{
"approvalLimitDate": "string",
"approvalStatus": {
"code": "APPROVED",
"name": "string"
},
"approved": true,
"approver": {
"firstName": "string",
"middleInitial": "string",
"href": "string",
"id": "string",
"lastName": "string",
"template": "string"
},
"authorizedDate": "string",
"businessPurpose": "string",
"canceledPostApproval": true,
"closed": false,
"comment": "string",
"comments": {
"href": "string",
"id": "string",
"template": "string"
},
"creationDate": "string",
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"endDate": "string",
"endTime": "string",
"everSentBack": false,
"expenses": [
{
"href": "string",
"id": "string",
"template": "string"
}
],
"extensionOf": {
"requestId": "string"
},
"highestExceptionLevel": "NONE",
"href": "string",
"id": "string",
"lastModified": "string",
"mainDestination": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"name": "string",
"operations": [
{
"href": "string",
"rel": "string"
}
],
"owner": {
"firstName": "string",
"middleInitial": "string",
"href": "string",
"id": "string",
"lastName": "string",
"template": "string"
},
"pendingApproval": true,
"policy": {
"href": "string",
"id": "string",
"template": "string"
},
"requestId": "string",
"startDate": "string",
"startTime": "string",
"submitDate": "string",
"totalApprovedAmount": {
"currency": "string",
"value": 1
},
"totalPostedAmount": {
"currency": "string",
"value": 1
},
"totalRemainingAmount": {
"currency": "string",
"value": 1
},
"travelAgency": {
"href": "string",
"id": "string",
"template": "string"
},
"type": {
"code": "string",
"label": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Request |
| 400 | Bad Request | The request is invalid | ErrorResponse |
| 401 | Unauthorized | Request is not authenticated | None |
| 403 | Forbidden | You do not have permission to perform this operation | None |
| 500 | Internal Server Error | An unexpected error has prevented the operation | ErrorResponse |
| 503 | Service Unavailable | The service is currently unavailable | ErrorResponse |
Travel Agency Resource
Get details of travel agencies integrated with Concur Request
getUsingGET_7
Code samples
# You can also use wget
curl -X GET /us.api.concursolutions.com/travelrequest/v4/travelagencies/{agencyUuid} \
-H 'Accept: application/json'
GET /us.api.concursolutions.com/travelrequest/v4/travelagencies/{agencyUuid} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('/us.api.concursolutions.com/travelrequest/v4/travelagencies/{agencyUuid}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get '/us.api.concursolutions.com/travelrequest/v4/travelagencies/{agencyUuid}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('/us.api.concursolutions.com/travelrequest/v4/travelagencies/{agencyUuid}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/us.api.concursolutions.com/travelrequest/v4/travelagencies/{agencyUuid}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/us.api.concursolutions.com/travelrequest/v4/travelagencies/{agencyUuid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/us.api.concursolutions.com/travelrequest/v4/travelagencies/{agencyUuid}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /travelagencies/{agencyUuid}
Get the description of a Travel Agency office
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| agencyUuid | path | string | true | The unique identifier of the Travel Agency |
Example responses
200 Response
{
"emailAddress": "string",
"id": "string",
"name": "string",
"proposalType": "CWTF"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | ResourceOfTravelAgency |
| 400 | Bad Request | The request is invalid | ErrorResponse |
| 401 | Unauthorized | Request is not authenticated | None |
| 403 | Forbidden | You do not have permission to perform this operation | None |
| 500 | Internal Server Error | An unexpected error has prevented the operation | ErrorResponse |
| 503 | Service Unavailable | The service is currently unavailable | ErrorResponse |
Policy Resource
Get available Request Policies
getListForUserUsingGET
Code samples
# You can also use wget
curl -X GET /us.api.concursolutions.com/travelrequest/v4/userpolicies \
-H 'Accept: application/json'
GET /us.api.concursolutions.com/travelrequest/v4/userpolicies HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('/us.api.concursolutions.com/travelrequest/v4/userpolicies',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get '/us.api.concursolutions.com/travelrequest/v4/userpolicies',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('/us.api.concursolutions.com/travelrequest/v4/userpolicies', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/us.api.concursolutions.com/travelrequest/v4/userpolicies', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/us.api.concursolutions.com/travelrequest/v4/userpolicies");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/us.api.concursolutions.com/travelrequest/v4/userpolicies", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /userpolicies
Get the list of existing Request Policies for a given user
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| userId | query | string | false | The unique identifier of the user for whom the list of Request policies will be retrieved |
Example responses
200 Response
[
{
"href": "string",
"id": "string",
"name": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Inline |
| 400 | Bad Request | The request is invalid | ErrorResponse |
| 401 | Unauthorized | Request is not authenticated | None |
| 403 | Forbidden | You do not have permission to perform this operation | None |
| 500 | Internal Server Error | An unexpected error has prevented the operation | ErrorResponse |
| 503 | Service Unavailable | The service is currently unavailable | ErrorResponse |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [ResourceOfPolicy] | false | none | none |
| » href | string | false | none | Hyperlink to the resource for this Request policy |
| » id | string | false | none | Unique identifier of the Request policy |
| » name | string | false | none | Name of the Request policy |
Expected Expense Resource
Manage expected expenses attached to a Request
listUsingGET
Code samples
# You can also use wget
curl -X GET /us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/expenses \
-H 'Accept: application/json'
GET /us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/expenses HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/expenses',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get '/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/expenses',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/expenses', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/expenses', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/expenses");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/expenses", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /requests/{requestUuid}/expenses
Get the list of expected expenses attached to a Request
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| requestUuid | path | string | true | The unique identifier of the Request |
| userId | query | string | false | The unique identifier of the user viewing the expected expenses attached to a Request |
Example responses
200 Response
[
{
"allocations": [
{
"allocationAmount": {
"currency": "string",
"value": 1
},
"allocationId": "string",
"approvedAmount": {
"currency": "string",
"value": 1
},
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"expenseId": "string",
"percentEdited": false,
"percentage": 0,
"postedAmount": {
"currency": "string",
"value": 1
},
"systemAllocation": false
}
],
"approvedAmount": {
"currency": "string",
"value": 1
},
"budgetAccrualDate": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"businessPurpose": "string",
"comments": {
"href": "string",
"id": "string",
"template": "string"
},
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom21": {
"code": "string",
"href": "string",
"value": "string"
},
"custom22": {
"code": "string",
"href": "string",
"value": "string"
},
"custom23": {
"code": "string",
"href": "string",
"value": "string"
},
"custom24": {
"code": "string",
"href": "string",
"value": "string"
},
"custom25": {
"code": "string",
"href": "string",
"value": "string"
},
"custom26": {
"code": "string",
"href": "string",
"value": "string"
},
"custom27": {
"code": "string",
"href": "string",
"value": "string"
},
"custom28": {
"code": "string",
"href": "string",
"value": "string"
},
"custom29": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom30": {
"code": "string",
"href": "string",
"value": "string"
},
"custom31": {
"code": "string",
"href": "string",
"value": "string"
},
"custom32": {
"code": "string",
"href": "string",
"value": "string"
},
"custom33": {
"code": "string",
"href": "string",
"value": "string"
},
"custom34": {
"code": "string",
"href": "string",
"value": "string"
},
"custom35": {
"code": "string",
"href": "string",
"value": "string"
},
"custom36": {
"code": "string",
"href": "string",
"value": "string"
},
"custom37": {
"code": "string",
"href": "string",
"value": "string"
},
"custom38": {
"code": "string",
"href": "string",
"value": "string"
},
"custom39": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom40": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"exchangeRate": {
"operation": "MULTIPLY",
"value": 0
},
"expenseType": {
"href": "string",
"id": "string",
"name": "string"
},
"href": "string",
"id": "string",
"lastComment": "string",
"lastModifiedDate": "string",
"location": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"orgUnit1": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit2": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit3": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit4": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit5": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit6": {
"code": "string",
"href": "string",
"value": "string"
},
"parentRequest": {
"href": "string",
"id": "string",
"template": "string"
},
"postedAmount": {
"currency": "string",
"value": 1
},
"remainingAmount": {
"currency": "string",
"value": 1
},
"source": "CASH_ADVANCE",
"transactionAmount": {
"currency": "string",
"value": 1
},
"transactionDate": "string",
"travelAllowance": {
"dailyTravelAllowanceId": "string"
},
"tripData": {
"agencyBooked": false,
"legs": [
{
"class": {
"code": "string",
"href": "string",
"value": "string"
},
"classOfService": "string",
"comment": "string",
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom21": {
"code": "string",
"href": "string",
"value": "string"
},
"custom22": {
"code": "string",
"href": "string",
"value": "string"
},
"custom23": {
"code": "string",
"href": "string",
"value": "string"
},
"custom24": {
"code": "string",
"href": "string",
"value": "string"
},
"custom25": {
"code": "string",
"href": "string",
"value": "string"
},
"custom26": {
"code": "string",
"href": "string",
"value": "string"
},
"custom27": {
"code": "string",
"href": "string",
"value": "string"
},
"custom28": {
"code": "string",
"href": "string",
"value": "string"
},
"custom29": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom30": {
"code": "string",
"href": "string",
"value": "string"
},
"custom31": {
"code": "string",
"href": "string",
"value": "string"
},
"custom32": {
"code": "string",
"href": "string",
"value": "string"
},
"custom33": {
"code": "string",
"href": "string",
"value": "string"
},
"custom34": {
"code": "string",
"href": "string",
"value": "string"
},
"custom35": {
"code": "string",
"href": "string",
"value": "string"
},
"custom36": {
"code": "string",
"href": "string",
"value": "string"
},
"custom37": {
"code": "string",
"href": "string",
"value": "string"
},
"custom38": {
"code": "string",
"href": "string",
"value": "string"
},
"custom39": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom40": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"endDate": "string",
"endLocation": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"endLocationDetail": "string",
"endTime": "string",
"id": "string",
"returnLeg": false,
"segmentLocator": "string",
"startDate": "string",
"startLocation": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"startLocationDetail": "string",
"startTime": "string",
"vendorName": "string"
}
],
"segmentType": {
"category": "REQ_SEG_AIRFR",
"code": "string"
},
"selfBooked": false,
"tripType": "ONE_WAY"
},
"vendor": {
"id": "string",
"name": "string"
}
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Inline |
| 400 | Bad Request | The request is invalid | ErrorResponse |
| 401 | Unauthorized | Request is not authenticated | None |
| 403 | Forbidden | You do not have permission to perform this operation | None |
| 500 | Internal Server Error | An unexpected error has prevented the operation | ErrorResponse |
| 503 | Service Unavailable | The service is currently unavailable | ErrorResponse |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [Expense] | false | none | none |
| » allocations | [Allocation] | false | none | List of the allocations composing this segment |
| »» allocationAmount | Amount | false | none | none |
| »»» currency | string | true | none | The 3-letter ISO 4217 code of the currency in which the amount is expressed |
| »»» value | number | true | none | The amount in the defined currency |
| »» allocationId | string | false | none | The unique allocation identifier. |
| »» approvedAmount | Amount | false | none | none |
| »» custom1 | CustomField | false | none | none |
| »»» code | string | false | none | The short code of the list item. For non-list fields, this value will be blank |
| »»» href | string | false | none | The link to get this list item on the list service. |
| »»» value | string | false | none | The value of the custom field or the value of the list item id for list fields |
| »» custom10 | CustomField | false | none | none |
| »» custom11 | CustomField | false | none | none |
| »» custom12 | CustomField | false | none | none |
| »» custom13 | CustomField | false | none | none |
| »» custom14 | CustomField | false | none | none |
| »» custom15 | CustomField | false | none | none |
| »» custom16 | CustomField | false | none | none |
| »» custom17 | CustomField | false | none | none |
| »» custom18 | CustomField | false | none | none |
| »» custom19 | CustomField | false | none | none |
| »» custom2 | CustomField | false | none | none |
| »» custom20 | CustomField | false | none | none |
| »» custom3 | CustomField | false | none | none |
| »» custom4 | CustomField | false | none | none |
| »» custom5 | CustomField | false | none | none |
| »» custom6 | CustomField | false | none | none |
| »» custom7 | CustomField | false | none | none |
| »» custom8 | CustomField | false | none | none |
| »» custom9 | CustomField | false | none | none |
| »» expenseId | string | false | none | The unique identifier of the expense associated with the allocation |
| »» percentEdited | boolean | false | none | Whether the allocation percent has been edited |
| »» percentage | number | false | none | The percentage of the total expense that this allocation represents |
| »» postedAmount | Amount | false | none | none |
| »» systemAllocation | boolean | false | none | Whether the allocation is a system allocation. It is usually hidden or read only for Request users |
| » approvedAmount | Amount | false | none | none |
| » budgetAccrualDate | string | false | none | The date to determine which budgets are affected (in the format yyyy-MM-dd’T’HH:mm:ss.SSS’Z’) |
| » businessPurpose | string | false | none | The purpose of the expected expense |
| » comments | ResourceLink | false | none | none |
| »» href | string | false | none | Hyperlink to the resource |
| »» id | string | false | none | Unique identifier of the related object |
| »» template | string | false | none | Hyperlink template to the resource |
| » custom1 | CustomField | false | none | none |
| » custom10 | CustomField | false | none | none |
| » custom11 | CustomField | false | none | none |
| » custom12 | CustomField | false | none | none |
| » custom13 | CustomField | false | none | none |
| » custom14 | CustomField | false | none | none |
| » custom15 | CustomField | false | none | none |
| » custom16 | CustomField | false | none | none |
| » custom17 | CustomField | false | none | none |
| » custom18 | CustomField | false | none | none |
| » custom19 | CustomField | false | none | none |
| » custom2 | CustomField | false | none | none |
| » custom20 | CustomField | false | none | none |
| » custom21 | CustomField | false | none | none |
| » custom22 | CustomField | false | none | none |
| » custom23 | CustomField | false | none | none |
| » custom24 | CustomField | false | none | none |
| » custom25 | CustomField | false | none | none |
| » custom26 | CustomField | false | none | none |
| » custom27 | CustomField | false | none | none |
| » custom28 | CustomField | false | none | none |
| » custom29 | CustomField | false | none | none |
| » custom3 | CustomField | false | none | none |
| » custom30 | CustomField | false | none | none |
| » custom31 | CustomField | false | none | none |
| » custom32 | CustomField | false | none | none |
| » custom33 | CustomField | false | none | none |
| » custom34 | CustomField | false | none | none |
| » custom35 | CustomField | false | none | none |
| » custom36 | CustomField | false | none | none |
| » custom37 | CustomField | false | none | none |
| » custom38 | CustomField | false | none | none |
| » custom39 | CustomField | false | none | none |
| » custom4 | CustomField | false | none | none |
| » custom40 | CustomField | false | none | none |
| » custom5 | CustomField | false | none | none |
| » custom6 | CustomField | false | none | none |
| » custom7 | CustomField | false | none | none |
| » custom8 | CustomField | false | none | none |
| » custom9 | CustomField | false | none | none |
| » exchangeRate | ExchangeRate | false | none | none |
| »» operation | string | true | none | Exchange rate operation. Possible values: 'MULTIPLY' or 'DIVIDE' |
| »» value | number | true | none | Exchange rate value |
| » expenseType | ExpenseType | false | none | none |
| »» href | string | false | none | Hyperlink to the resource for the expense type definition |
| »» id | string | true | none | Unique identifier of the expense type |
| »» name | string | false | none | Name of the expense type |
| » href | string | false | none | none |
| » id | string | false | none | The unique identifier of the expected expense |
| » lastComment | string | false | none | The last comment of the expected expense |
| » lastModifiedDate | string | false | none | The date when this expense was last modified |
| » location | Location | false | none | none |
| »» city | string | false | none | The city name of the location |
| »» countryCode | string | false | none | The ISO 3166-1 country code |
| »» countrySubDivisionCode | string | false | none | The ISO 3166-2 country sub code |
| »» iataCode | string | false | none | The IATA code for the location |
| »» id | string | false | none | The id of the location |
| »» latitude | number | false | none | The latitude of the location |
| »» locationCode | string | false | none | The code of the location |
| »» locationType | string | false | none | The type of the location |
| »» longitude | number | false | none | The longitude of the location |
| »» name | string | false | none | The name of the location |
| » orgUnit1 | CustomField | false | none | none |
| » orgUnit2 | CustomField | false | none | none |
| » orgUnit3 | CustomField | false | none | none |
| » orgUnit4 | CustomField | false | none | none |
| » orgUnit5 | CustomField | false | none | none |
| » orgUnit6 | CustomField | false | none | none |
| » parentRequest | ResourceLink | false | none | none |
| » postedAmount | Amount | false | none | none |
| » remainingAmount | Amount | false | none | none |
| » source | string | false | none | The source that created the expected expense. It can be CASH_ADVANCE or TRAVEL_ALLOWANCE. This field will be empty in any other case. |
| » transactionAmount | Amount | false | none | none |
| » transactionDate | string | true | none | The date of the transaction |
| » travelAllowance | TravelAllowance | false | none | none |
| »» dailyTravelAllowanceId | string | false | none | The fixed daily travel allowance id associated with the expected expense |
| » tripData | TripData | false | none | none |
| »» agencyBooked | boolean | false | none | Indicates whether this trip has been booked by a Travel Agency or not. True if this trip is (or has to be) handled by a Travel Agency. |
| »» legs | [SegmentLeg] | false | none | List of the legs composing this segment |
| »»» class | ListItemField | false | none | none |
| »»»» code | string | false | none | The short code of the list item. |
| »»»» href | string | false | none | Hyperlink to the resource for the list item. |
| »»»» value | string | false | none | The value of the list item id. |
| »»» classOfService | string | false | none | The class of service of the segment leg. For example, in the case of an air segment, this field would contain the one-letter booking code: Y for economy class, or F for first class... |
| »»» comment | string | false | none | A comment for this segment leg |
| »»» custom1 | CustomField | false | none | none |
| »»» custom10 | CustomField | false | none | none |
| »»» custom11 | CustomField | false | none | none |
| »»» custom12 | CustomField | false | none | none |
| »»» custom13 | CustomField | false | none | none |
| »»» custom14 | CustomField | false | none | none |
| »»» custom15 | CustomField | false | none | none |
| »»» custom16 | CustomField | false | none | none |
| »»» custom17 | CustomField | false | none | none |
| »»» custom18 | CustomField | false | none | none |
| »»» custom19 | CustomField | false | none | none |
| »»» custom2 | CustomField | false | none | none |
| »»» custom20 | CustomField | false | none | none |
| »»» custom21 | CustomField | false | none | none |
| »»» custom22 | CustomField | false | none | none |
| »»» custom23 | CustomField | false | none | none |
| »»» custom24 | CustomField | false | none | none |
| »»» custom25 | CustomField | false | none | none |
| »»» custom26 | CustomField | false | none | none |
| »»» custom27 | CustomField | false | none | none |
| »»» custom28 | CustomField | false | none | none |
| »»» custom29 | CustomField | false | none | none |
| »»» custom3 | CustomField | false | none | none |
| »»» custom30 | CustomField | false | none | none |
| »»» custom31 | CustomField | false | none | none |
| »»» custom32 | CustomField | false | none | none |
| »»» custom33 | CustomField | false | none | none |
| »»» custom34 | CustomField | false | none | none |
| »»» custom35 | CustomField | false | none | none |
| »»» custom36 | CustomField | false | none | none |
| »»» custom37 | CustomField | false | none | none |
| »»» custom38 | CustomField | false | none | none |
| »»» custom39 | CustomField | false | none | none |
| »»» custom4 | CustomField | false | none | none |
| »»» custom40 | CustomField | false | none | none |
| »»» custom5 | CustomField | false | none | none |
| »»» custom6 | CustomField | false | none | none |
| »»» custom7 | CustomField | false | none | none |
| »»» custom8 | CustomField | false | none | none |
| »»» custom9 | CustomField | false | none | none |
| »»» endDate | string | false | none | The end date of the segment leg (in the format YYYY-MM-DD).It represents the arrival date of AIRFR and TRAIN segments, check out date for HOTEL or drop off for CARRT |
| »»» endLocation | Location | false | none | none |
| »»» endLocationDetail | string | false | none | Additional details about the end location. It is used for HOTEL and CARRT segments. |
| »»» endTime | string | false | none | The end time of the segment leg (in the format HH:MM). It is expressed in the local time of the end location |
| »»» id | string | false | none | The unique identifier of the segment leg |
| »»» returnLeg | boolean | false | none | This value indicates if the leg is a return leg or not. |
| »»» segmentLocator | string | false | none | The identifier for Concur Travel segments |
| »»» startDate | string | false | none | The start date of the segment leg (in the format YYYY-MM-DD). It represents the departure date of AIRFR and TRAIN segments, check in date for HOTEL or pickup for CARRT |
| »»» startLocation | Location | false | none | none |
| »»» startLocationDetail | string | false | none | Additional details about the start location. It is used for HOTEL and CARRT segments. |
| »»» startTime | string | false | none | The start time of the segment leg (in the format HH:MM). It is expressed in the local time of the start location |
| »»» vendorName | string | false | none | The name of the vendor of this segment leg. |
| »» segmentType | SegmentType | true | none | none |
| »»» category | string | false | none | The category of the segment type |
| »»» code | string | false | none | The code of the segment type. This will most frequently be a String, but could also be an integer in the case of a custom expense typeFor example, would be category = REQ_SEG_AIRFR and code = AIRFR for a regular air segment, but category = REQ_SEG_AIRFR and code = 10325 for a custom air segment. |
| »» selfBooked | boolean | false | none | True if this trip has been reserved by Concur Travel, or if Concur Travel has retrieved the trip information in the GDS |
| »» tripType | string | false | none | Indicates the type of this trip. Possible values are: ONE_WAY, ROUND_TRIP, MULTI_STOPS |
| » vendor | Vendor | false | none | none |
| »» id | string | false | none | The vendor identifier of the expected expense |
| »» name | string | false | none | The vendor description of the expected expense |
Enumerated Values
| Property | Value |
|---|---|
| operation | MULTIPLY |
| operation | DIVIDE |
| source | CASH_ADVANCE |
| source | TRAVEL_ALLOWANCE |
| source | AGENCY_FEE |
| category | REQ_SEG_AIRFR |
| category | REQ_SEG_CARRT |
| category | REQ_SEG_HOTEL |
| category | REQ_SEG_LIMOF |
| category | REQ_SEG_RAILF |
| category | REQ_SEG_TAXIF |
| category | REQ_SEG_MISC |
| category | REQ_SEG_PARKG |
| category | REQ_SEG_DININ |
| category | REQ_SEG_EVENT |
| tripType | ONE_WAY |
| tripType | ROUND_TRIP |
| tripType | MULTI_STOPS |
createUsingPOST_2
Code samples
# You can also use wget
curl -X POST /us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/expenses \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
POST /us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/expenses HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"allocations": [
{
"allocationAmount": {
"currency": "string",
"value": 1
},
"allocationId": "string",
"approvedAmount": {
"currency": "string",
"value": 1
},
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"expenseId": "string",
"percentEdited": false,
"percentage": 0,
"postedAmount": {
"currency": "string",
"value": 1
},
"systemAllocation": false
}
],
"approvedAmount": {
"currency": "string",
"value": 1
},
"budgetAccrualDate": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"businessPurpose": "string",
"comments": {
"href": "string",
"id": "string",
"template": "string"
},
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom21": {
"code": "string",
"href": "string",
"value": "string"
},
"custom22": {
"code": "string",
"href": "string",
"value": "string"
},
"custom23": {
"code": "string",
"href": "string",
"value": "string"
},
"custom24": {
"code": "string",
"href": "string",
"value": "string"
},
"custom25": {
"code": "string",
"href": "string",
"value": "string"
},
"custom26": {
"code": "string",
"href": "string",
"value": "string"
},
"custom27": {
"code": "string",
"href": "string",
"value": "string"
},
"custom28": {
"code": "string",
"href": "string",
"value": "string"
},
"custom29": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom30": {
"code": "string",
"href": "string",
"value": "string"
},
"custom31": {
"code": "string",
"href": "string",
"value": "string"
},
"custom32": {
"code": "string",
"href": "string",
"value": "string"
},
"custom33": {
"code": "string",
"href": "string",
"value": "string"
},
"custom34": {
"code": "string",
"href": "string",
"value": "string"
},
"custom35": {
"code": "string",
"href": "string",
"value": "string"
},
"custom36": {
"code": "string",
"href": "string",
"value": "string"
},
"custom37": {
"code": "string",
"href": "string",
"value": "string"
},
"custom38": {
"code": "string",
"href": "string",
"value": "string"
},
"custom39": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom40": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"exchangeRate": {
"operation": "MULTIPLY",
"value": 0
},
"expenseType": {
"href": "string",
"id": "string",
"name": "string"
},
"href": "string",
"id": "string",
"lastComment": "string",
"lastModifiedDate": "string",
"location": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"orgUnit1": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit2": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit3": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit4": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit5": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit6": {
"code": "string",
"href": "string",
"value": "string"
},
"parentRequest": {
"href": "string",
"id": "string",
"template": "string"
},
"postedAmount": {
"currency": "string",
"value": 1
},
"remainingAmount": {
"currency": "string",
"value": 1
},
"source": "CASH_ADVANCE",
"transactionAmount": {
"currency": "string",
"value": 1
},
"transactionDate": "string",
"travelAllowance": {
"dailyTravelAllowanceId": "string"
},
"tripData": {
"agencyBooked": false,
"legs": [
{
"class": {
"code": "string",
"href": "string",
"value": "string"
},
"classOfService": "string",
"comment": "string",
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom21": {
"code": "string",
"href": "string",
"value": "string"
},
"custom22": {
"code": "string",
"href": "string",
"value": "string"
},
"custom23": {
"code": "string",
"href": "string",
"value": "string"
},
"custom24": {
"code": "string",
"href": "string",
"value": "string"
},
"custom25": {
"code": "string",
"href": "string",
"value": "string"
},
"custom26": {
"code": "string",
"href": "string",
"value": "string"
},
"custom27": {
"code": "string",
"href": "string",
"value": "string"
},
"custom28": {
"code": "string",
"href": "string",
"value": "string"
},
"custom29": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom30": {
"code": "string",
"href": "string",
"value": "string"
},
"custom31": {
"code": "string",
"href": "string",
"value": "string"
},
"custom32": {
"code": "string",
"href": "string",
"value": "string"
},
"custom33": {
"code": "string",
"href": "string",
"value": "string"
},
"custom34": {
"code": "string",
"href": "string",
"value": "string"
},
"custom35": {
"code": "string",
"href": "string",
"value": "string"
},
"custom36": {
"code": "string",
"href": "string",
"value": "string"
},
"custom37": {
"code": "string",
"href": "string",
"value": "string"
},
"custom38": {
"code": "string",
"href": "string",
"value": "string"
},
"custom39": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom40": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"endDate": "string",
"endLocation": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"endLocationDetail": "string",
"endTime": "string",
"id": "string",
"returnLeg": false,
"segmentLocator": "string",
"startDate": "string",
"startLocation": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"startLocationDetail": "string",
"startTime": "string",
"vendorName": "string"
}
],
"segmentType": {
"category": "REQ_SEG_AIRFR",
"code": "string"
},
"selfBooked": false,
"tripType": "ONE_WAY"
},
"vendor": {
"id": "string",
"name": "string"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/expenses',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post '/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/expenses',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/expenses', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/expenses', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/expenses");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/us.api.concursolutions.com/travelrequest/v4/requests/{requestUuid}/expenses", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /requests/{requestUuid}/expenses
Create a new expected expense
Body parameter
{
"allocations": [
{
"allocationAmount": {
"currency": "string",
"value": 1
},
"allocationId": "string",
"approvedAmount": {
"currency": "string",
"value": 1
},
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"expenseId": "string",
"percentEdited": false,
"percentage": 0,
"postedAmount": {
"currency": "string",
"value": 1
},
"systemAllocation": false
}
],
"approvedAmount": {
"currency": "string",
"value": 1
},
"budgetAccrualDate": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"businessPurpose": "string",
"comments": {
"href": "string",
"id": "string",
"template": "string"
},
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom21": {
"code": "string",
"href": "string",
"value": "string"
},
"custom22": {
"code": "string",
"href": "string",
"value": "string"
},
"custom23": {
"code": "string",
"href": "string",
"value": "string"
},
"custom24": {
"code": "string",
"href": "string",
"value": "string"
},
"custom25": {
"code": "string",
"href": "string",
"value": "string"
},
"custom26": {
"code": "string",
"href": "string",
"value": "string"
},
"custom27": {
"code": "string",
"href": "string",
"value": "string"
},
"custom28": {
"code": "string",
"href": "string",
"value": "string"
},
"custom29": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom30": {
"code": "string",
"href": "string",
"value": "string"
},
"custom31": {
"code": "string",
"href": "string",
"value": "string"
},
"custom32": {
"code": "string",
"href": "string",
"value": "string"
},
"custom33": {
"code": "string",
"href": "string",
"value": "string"
},
"custom34": {
"code": "string",
"href": "string",
"value": "string"
},
"custom35": {
"code": "string",
"href": "string",
"value": "string"
},
"custom36": {
"code": "string",
"href": "string",
"value": "string"
},
"custom37": {
"code": "string",
"href": "string",
"value": "string"
},
"custom38": {
"code": "string",
"href": "string",
"value": "string"
},
"custom39": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom40": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"exchangeRate": {
"operation": "MULTIPLY",
"value": 0
},
"expenseType": {
"href": "string",
"id": "string",
"name": "string"
},
"href": "string",
"id": "string",
"lastComment": "string",
"lastModifiedDate": "string",
"location": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"orgUnit1": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit2": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit3": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit4": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit5": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit6": {
"code": "string",
"href": "string",
"value": "string"
},
"parentRequest": {
"href": "string",
"id": "string",
"template": "string"
},
"postedAmount": {
"currency": "string",
"value": 1
},
"remainingAmount": {
"currency": "string",
"value": 1
},
"source": "CASH_ADVANCE",
"transactionAmount": {
"currency": "string",
"value": 1
},
"transactionDate": "string",
"travelAllowance": {
"dailyTravelAllowanceId": "string"
},
"tripData": {
"agencyBooked": false,
"legs": [
{
"class": {
"code": "string",
"href": "string",
"value": "string"
},
"classOfService": "string",
"comment": "string",
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom21": {
"code": "string",
"href": "string",
"value": "string"
},
"custom22": {
"code": "string",
"href": "string",
"value": "string"
},
"custom23": {
"code": "string",
"href": "string",
"value": "string"
},
"custom24": {
"code": "string",
"href": "string",
"value": "string"
},
"custom25": {
"code": "string",
"href": "string",
"value": "string"
},
"custom26": {
"code": "string",
"href": "string",
"value": "string"
},
"custom27": {
"code": "string",
"href": "string",
"value": "string"
},
"custom28": {
"code": "string",
"href": "string",
"value": "string"
},
"custom29": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom30": {
"code": "string",
"href": "string",
"value": "string"
},
"custom31": {
"code": "string",
"href": "string",
"value": "string"
},
"custom32": {
"code": "string",
"href": "string",
"value": "string"
},
"custom33": {
"code": "string",
"href": "string",
"value": "string"
},
"custom34": {
"code": "string",
"href": "string",
"value": "string"
},
"custom35": {
"code": "string",
"href": "string",
"value": "string"
},
"custom36": {
"code": "string",
"href": "string",
"value": "string"
},
"custom37": {
"code": "string",
"href": "string",
"value": "string"
},
"custom38": {
"code": "string",
"href": "string",
"value": "string"
},
"custom39": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom40": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"endDate": "string",
"endLocation": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"endLocationDetail": "string",
"endTime": "string",
"id": "string",
"returnLeg": false,
"segmentLocator": "string",
"startDate": "string",
"startLocation": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"startLocationDetail": "string",
"startTime": "string",
"vendorName": "string"
}
],
"segmentType": {
"category": "REQ_SEG_AIRFR",
"code": "string"
},
"selfBooked": false,
"tripType": "ONE_WAY"
},
"vendor": {
"id": "string",
"name": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| requestUuid | path | string | true | The unique identifier of the Request to which the expected expense is attached |
| userId | query | string | false | The unique identifier of the user performing the expected expense creation |
| body | body | Expense | true | expense |
Example responses
201 Response
{
"allocations": [
{
"allocationAmount": {
"currency": "string",
"value": 1
},
"allocationId": "string",
"approvedAmount": {
"currency": "string",
"value": 1
},
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"expenseId": "string",
"percentEdited": false,
"percentage": 0,
"postedAmount": {
"currency": "string",
"value": 1
},
"systemAllocation": false
}
],
"approvedAmount": {
"currency": "string",
"value": 1
},
"budgetAccrualDate": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"businessPurpose": "string",
"comments": {
"href": "string",
"id": "string",
"template": "string"
},
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom21": {
"code": "string",
"href": "string",
"value": "string"
},
"custom22": {
"code": "string",
"href": "string",
"value": "string"
},
"custom23": {
"code": "string",
"href": "string",
"value": "string"
},
"custom24": {
"code": "string",
"href": "string",
"value": "string"
},
"custom25": {
"code": "string",
"href": "string",
"value": "string"
},
"custom26": {
"code": "string",
"href": "string",
"value": "string"
},
"custom27": {
"code": "string",
"href": "string",
"value": "string"
},
"custom28": {
"code": "string",
"href": "string",
"value": "string"
},
"custom29": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom30": {
"code": "string",
"href": "string",
"value": "string"
},
"custom31": {
"code": "string",
"href": "string",
"value": "string"
},
"custom32": {
"code": "string",
"href": "string",
"value": "string"
},
"custom33": {
"code": "string",
"href": "string",
"value": "string"
},
"custom34": {
"code": "string",
"href": "string",
"value": "string"
},
"custom35": {
"code": "string",
"href": "string",
"value": "string"
},
"custom36": {
"code": "string",
"href": "string",
"value": "string"
},
"custom37": {
"code": "string",
"href": "string",
"value": "string"
},
"custom38": {
"code": "string",
"href": "string",
"value": "string"
},
"custom39": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom40": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"exchangeRate": {
"operation": "MULTIPLY",
"value": 0
},
"expenseType": {
"href": "string",
"id": "string",
"name": "string"
},
"href": "string",
"id": "string",
"lastComment": "string",
"lastModifiedDate": "string",
"location": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"orgUnit1": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit2": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit3": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit4": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit5": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit6": {
"code": "string",
"href": "string",
"value": "string"
},
"parentRequest": {
"href": "string",
"id": "string",
"template": "string"
},
"postedAmount": {
"currency": "string",
"value": 1
},
"remainingAmount": {
"currency": "string",
"value": 1
},
"source": "CASH_ADVANCE",
"transactionAmount": {
"currency": "string",
"value": 1
},
"transactionDate": "string",
"travelAllowance": {
"dailyTravelAllowanceId": "string"
},
"tripData": {
"agencyBooked": false,
"legs": [
{
"class": {
"code": "string",
"href": "string",
"value": "string"
},
"classOfService": "string",
"comment": "string",
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom21": {
"code": "string",
"href": "string",
"value": "string"
},
"custom22": {
"code": "string",
"href": "string",
"value": "string"
},
"custom23": {
"code": "string",
"href": "string",
"value": "string"
},
"custom24": {
"code": "string",
"href": "string",
"value": "string"
},
"custom25": {
"code": "string",
"href": "string",
"value": "string"
},
"custom26": {
"code": "string",
"href": "string",
"value": "string"
},
"custom27": {
"code": "string",
"href": "string",
"value": "string"
},
"custom28": {
"code": "string",
"href": "string",
"value": "string"
},
"custom29": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom30": {
"code": "string",
"href": "string",
"value": "string"
},
"custom31": {
"code": "string",
"href": "string",
"value": "string"
},
"custom32": {
"code": "string",
"href": "string",
"value": "string"
},
"custom33": {
"code": "string",
"href": "string",
"value": "string"
},
"custom34": {
"code": "string",
"href": "string",
"value": "string"
},
"custom35": {
"code": "string",
"href": "string",
"value": "string"
},
"custom36": {
"code": "string",
"href": "string",
"value": "string"
},
"custom37": {
"code": "string",
"href": "string",
"value": "string"
},
"custom38": {
"code": "string",
"href": "string",
"value": "string"
},
"custom39": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom40": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"endDate": "string",
"endLocation": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"endLocationDetail": "string",
"endTime": "string",
"id": "string",
"returnLeg": false,
"segmentLocator": "string",
"startDate": "string",
"startLocation": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"startLocationDetail": "string",
"startTime": "string",
"vendorName": "string"
}
],
"segmentType": {
"category": "REQ_SEG_AIRFR",
"code": "string"
},
"selfBooked": false,
"tripType": "ONE_WAY"
},
"vendor": {
"id": "string",
"name": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Created | Expense |
| 400 | Bad Request | The request is invalid | ErrorResponse |
| 401 | Unauthorized | Request is not authenticated | None |
| 403 | Forbidden | You do not have permission to perform this operation | None |
| 500 | Internal Server Error | An unexpected error has prevented the operation | ErrorResponse |
| 503 | Service Unavailable | The service is currently unavailable | ErrorResponse |
getUsingGET_2
Code samples
# You can also use wget
curl -X GET /us.api.concursolutions.com/travelrequest/v4/expenses/{expenseUuid} \
-H 'Accept: application/json'
GET /us.api.concursolutions.com/travelrequest/v4/expenses/{expenseUuid} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('/us.api.concursolutions.com/travelrequest/v4/expenses/{expenseUuid}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get '/us.api.concursolutions.com/travelrequest/v4/expenses/{expenseUuid}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('/us.api.concursolutions.com/travelrequest/v4/expenses/{expenseUuid}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/us.api.concursolutions.com/travelrequest/v4/expenses/{expenseUuid}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/us.api.concursolutions.com/travelrequest/v4/expenses/{expenseUuid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/us.api.concursolutions.com/travelrequest/v4/expenses/{expenseUuid}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /expenses/{expenseUuid}
Get the content of an expected expense
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| expenseUuid | path | string | true | The unique identifier of the expected expense |
| userId | query | string | false | The unique identifier of the user viewing the expected expense |
Example responses
200 Response
{
"allocations": [
{
"allocationAmount": {
"currency": "string",
"value": 1
},
"allocationId": "string",
"approvedAmount": {
"currency": "string",
"value": 1
},
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"expenseId": "string",
"percentEdited": false,
"percentage": 0,
"postedAmount": {
"currency": "string",
"value": 1
},
"systemAllocation": false
}
],
"approvedAmount": {
"currency": "string",
"value": 1
},
"budgetAccrualDate": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"businessPurpose": "string",
"comments": {
"href": "string",
"id": "string",
"template": "string"
},
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom21": {
"code": "string",
"href": "string",
"value": "string"
},
"custom22": {
"code": "string",
"href": "string",
"value": "string"
},
"custom23": {
"code": "string",
"href": "string",
"value": "string"
},
"custom24": {
"code": "string",
"href": "string",
"value": "string"
},
"custom25": {
"code": "string",
"href": "string",
"value": "string"
},
"custom26": {
"code": "string",
"href": "string",
"value": "string"
},
"custom27": {
"code": "string",
"href": "string",
"value": "string"
},
"custom28": {
"code": "string",
"href": "string",
"value": "string"
},
"custom29": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom30": {
"code": "string",
"href": "string",
"value": "string"
},
"custom31": {
"code": "string",
"href": "string",
"value": "string"
},
"custom32": {
"code": "string",
"href": "string",
"value": "string"
},
"custom33": {
"code": "string",
"href": "string",
"value": "string"
},
"custom34": {
"code": "string",
"href": "string",
"value": "string"
},
"custom35": {
"code": "string",
"href": "string",
"value": "string"
},
"custom36": {
"code": "string",
"href": "string",
"value": "string"
},
"custom37": {
"code": "string",
"href": "string",
"value": "string"
},
"custom38": {
"code": "string",
"href": "string",
"value": "string"
},
"custom39": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom40": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"exchangeRate": {
"operation": "MULTIPLY",
"value": 0
},
"expenseType": {
"href": "string",
"id": "string",
"name": "string"
},
"href": "string",
"id": "string",
"lastComment": "string",
"lastModifiedDate": "string",
"location": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"orgUnit1": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit2": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit3": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit4": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit5": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit6": {
"code": "string",
"href": "string",
"value": "string"
},
"parentRequest": {
"href": "string",
"id": "string",
"template": "string"
},
"postedAmount": {
"currency": "string",
"value": 1
},
"remainingAmount": {
"currency": "string",
"value": 1
},
"source": "CASH_ADVANCE",
"transactionAmount": {
"currency": "string",
"value": 1
},
"transactionDate": "string",
"travelAllowance": {
"dailyTravelAllowanceId": "string"
},
"tripData": {
"agencyBooked": false,
"legs": [
{
"class": {
"code": "string",
"href": "string",
"value": "string"
},
"classOfService": "string",
"comment": "string",
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom21": {
"code": "string",
"href": "string",
"value": "string"
},
"custom22": {
"code": "string",
"href": "string",
"value": "string"
},
"custom23": {
"code": "string",
"href": "string",
"value": "string"
},
"custom24": {
"code": "string",
"href": "string",
"value": "string"
},
"custom25": {
"code": "string",
"href": "string",
"value": "string"
},
"custom26": {
"code": "string",
"href": "string",
"value": "string"
},
"custom27": {
"code": "string",
"href": "string",
"value": "string"
},
"custom28": {
"code": "string",
"href": "string",
"value": "string"
},
"custom29": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom30": {
"code": "string",
"href": "string",
"value": "string"
},
"custom31": {
"code": "string",
"href": "string",
"value": "string"
},
"custom32": {
"code": "string",
"href": "string",
"value": "string"
},
"custom33": {
"code": "string",
"href": "string",
"value": "string"
},
"custom34": {
"code": "string",
"href": "string",
"value": "string"
},
"custom35": {
"code": "string",
"href": "string",
"value": "string"
},
"custom36": {
"code": "string",
"href": "string",
"value": "string"
},
"custom37": {
"code": "string",
"href": "string",
"value": "string"
},
"custom38": {
"code": "string",
"href": "string",
"value": "string"
},
"custom39": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom40": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"endDate": "string",
"endLocation": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"endLocationDetail": "string",
"endTime": "string",
"id": "string",
"returnLeg": false,
"segmentLocator": "string",
"startDate": "string",
"startLocation": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"startLocationDetail": "string",
"startTime": "string",
"vendorName": "string"
}
],
"segmentType": {
"category": "REQ_SEG_AIRFR",
"code": "string"
},
"selfBooked": false,
"tripType": "ONE_WAY"
},
"vendor": {
"id": "string",
"name": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Expense |
| 400 | Bad Request | The request is invalid | ErrorResponse |
| 401 | Unauthorized | Request is not authenticated | None |
| 403 | Forbidden | You do not have permission to perform this operation | None |
| 500 | Internal Server Error | An unexpected error has prevented the operation | ErrorResponse |
| 503 | Service Unavailable | The service is currently unavailable | ErrorResponse |
updateUsingPUT
Code samples
# You can also use wget
curl -X PUT /us.api.concursolutions.com/travelrequest/v4/expenses/{expenseUuid} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
PUT /us.api.concursolutions.com/travelrequest/v4/expenses/{expenseUuid} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"allocations": [
{
"allocationAmount": {
"currency": "string",
"value": 1
},
"allocationId": "string",
"approvedAmount": {
"currency": "string",
"value": 1
},
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"expenseId": "string",
"percentEdited": false,
"percentage": 0,
"postedAmount": {
"currency": "string",
"value": 1
},
"systemAllocation": false
}
],
"approvedAmount": {
"currency": "string",
"value": 1
},
"budgetAccrualDate": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"businessPurpose": "string",
"comments": {
"href": "string",
"id": "string",
"template": "string"
},
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom21": {
"code": "string",
"href": "string",
"value": "string"
},
"custom22": {
"code": "string",
"href": "string",
"value": "string"
},
"custom23": {
"code": "string",
"href": "string",
"value": "string"
},
"custom24": {
"code": "string",
"href": "string",
"value": "string"
},
"custom25": {
"code": "string",
"href": "string",
"value": "string"
},
"custom26": {
"code": "string",
"href": "string",
"value": "string"
},
"custom27": {
"code": "string",
"href": "string",
"value": "string"
},
"custom28": {
"code": "string",
"href": "string",
"value": "string"
},
"custom29": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom30": {
"code": "string",
"href": "string",
"value": "string"
},
"custom31": {
"code": "string",
"href": "string",
"value": "string"
},
"custom32": {
"code": "string",
"href": "string",
"value": "string"
},
"custom33": {
"code": "string",
"href": "string",
"value": "string"
},
"custom34": {
"code": "string",
"href": "string",
"value": "string"
},
"custom35": {
"code": "string",
"href": "string",
"value": "string"
},
"custom36": {
"code": "string",
"href": "string",
"value": "string"
},
"custom37": {
"code": "string",
"href": "string",
"value": "string"
},
"custom38": {
"code": "string",
"href": "string",
"value": "string"
},
"custom39": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom40": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"exchangeRate": {
"operation": "MULTIPLY",
"value": 0
},
"expenseType": {
"href": "string",
"id": "string",
"name": "string"
},
"href": "string",
"id": "string",
"lastComment": "string",
"lastModifiedDate": "string",
"location": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"orgUnit1": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit2": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit3": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit4": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit5": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit6": {
"code": "string",
"href": "string",
"value": "string"
},
"parentRequest": {
"href": "string",
"id": "string",
"template": "string"
},
"postedAmount": {
"currency": "string",
"value": 1
},
"remainingAmount": {
"currency": "string",
"value": 1
},
"source": "CASH_ADVANCE",
"transactionAmount": {
"currency": "string",
"value": 1
},
"transactionDate": "string",
"travelAllowance": {
"dailyTravelAllowanceId": "string"
},
"tripData": {
"agencyBooked": false,
"legs": [
{
"class": {
"code": "string",
"href": "string",
"value": "string"
},
"classOfService": "string",
"comment": "string",
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom21": {
"code": "string",
"href": "string",
"value": "string"
},
"custom22": {
"code": "string",
"href": "string",
"value": "string"
},
"custom23": {
"code": "string",
"href": "string",
"value": "string"
},
"custom24": {
"code": "string",
"href": "string",
"value": "string"
},
"custom25": {
"code": "string",
"href": "string",
"value": "string"
},
"custom26": {
"code": "string",
"href": "string",
"value": "string"
},
"custom27": {
"code": "string",
"href": "string",
"value": "string"
},
"custom28": {
"code": "string",
"href": "string",
"value": "string"
},
"custom29": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom30": {
"code": "string",
"href": "string",
"value": "string"
},
"custom31": {
"code": "string",
"href": "string",
"value": "string"
},
"custom32": {
"code": "string",
"href": "string",
"value": "string"
},
"custom33": {
"code": "string",
"href": "string",
"value": "string"
},
"custom34": {
"code": "string",
"href": "string",
"value": "string"
},
"custom35": {
"code": "string",
"href": "string",
"value": "string"
},
"custom36": {
"code": "string",
"href": "string",
"value": "string"
},
"custom37": {
"code": "string",
"href": "string",
"value": "string"
},
"custom38": {
"code": "string",
"href": "string",
"value": "string"
},
"custom39": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom40": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"endDate": "string",
"endLocation": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"endLocationDetail": "string",
"endTime": "string",
"id": "string",
"returnLeg": false,
"segmentLocator": "string",
"startDate": "string",
"startLocation": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"startLocationDetail": "string",
"startTime": "string",
"vendorName": "string"
}
],
"segmentType": {
"category": "REQ_SEG_AIRFR",
"code": "string"
},
"selfBooked": false,
"tripType": "ONE_WAY"
},
"vendor": {
"id": "string",
"name": "string"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('/us.api.concursolutions.com/travelrequest/v4/expenses/{expenseUuid}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.put '/us.api.concursolutions.com/travelrequest/v4/expenses/{expenseUuid}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.put('/us.api.concursolutions.com/travelrequest/v4/expenses/{expenseUuid}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/us.api.concursolutions.com/travelrequest/v4/expenses/{expenseUuid}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/us.api.concursolutions.com/travelrequest/v4/expenses/{expenseUuid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/us.api.concursolutions.com/travelrequest/v4/expenses/{expenseUuid}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /expenses/{expenseUuid}
Update the content of an expected expense
Body parameter
{
"allocations": [
{
"allocationAmount": {
"currency": "string",
"value": 1
},
"allocationId": "string",
"approvedAmount": {
"currency": "string",
"value": 1
},
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"expenseId": "string",
"percentEdited": false,
"percentage": 0,
"postedAmount": {
"currency": "string",
"value": 1
},
"systemAllocation": false
}
],
"approvedAmount": {
"currency": "string",
"value": 1
},
"budgetAccrualDate": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"businessPurpose": "string",
"comments": {
"href": "string",
"id": "string",
"template": "string"
},
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom21": {
"code": "string",
"href": "string",
"value": "string"
},
"custom22": {
"code": "string",
"href": "string",
"value": "string"
},
"custom23": {
"code": "string",
"href": "string",
"value": "string"
},
"custom24": {
"code": "string",
"href": "string",
"value": "string"
},
"custom25": {
"code": "string",
"href": "string",
"value": "string"
},
"custom26": {
"code": "string",
"href": "string",
"value": "string"
},
"custom27": {
"code": "string",
"href": "string",
"value": "string"
},
"custom28": {
"code": "string",
"href": "string",
"value": "string"
},
"custom29": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom30": {
"code": "string",
"href": "string",
"value": "string"
},
"custom31": {
"code": "string",
"href": "string",
"value": "string"
},
"custom32": {
"code": "string",
"href": "string",
"value": "string"
},
"custom33": {
"code": "string",
"href": "string",
"value": "string"
},
"custom34": {
"code": "string",
"href": "string",
"value": "string"
},
"custom35": {
"code": "string",
"href": "string",
"value": "string"
},
"custom36": {
"code": "string",
"href": "string",
"value": "string"
},
"custom37": {
"code": "string",
"href": "string",
"value": "string"
},
"custom38": {
"code": "string",
"href": "string",
"value": "string"
},
"custom39": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom40": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"exchangeRate": {
"operation": "MULTIPLY",
"value": 0
},
"expenseType": {
"href": "string",
"id": "string",
"name": "string"
},
"href": "string",
"id": "string",
"lastComment": "string",
"lastModifiedDate": "string",
"location": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"orgUnit1": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit2": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit3": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit4": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit5": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit6": {
"code": "string",
"href": "string",
"value": "string"
},
"parentRequest": {
"href": "string",
"id": "string",
"template": "string"
},
"postedAmount": {
"currency": "string",
"value": 1
},
"remainingAmount": {
"currency": "string",
"value": 1
},
"source": "CASH_ADVANCE",
"transactionAmount": {
"currency": "string",
"value": 1
},
"transactionDate": "string",
"travelAllowance": {
"dailyTravelAllowanceId": "string"
},
"tripData": {
"agencyBooked": false,
"legs": [
{
"class": {
"code": "string",
"href": "string",
"value": "string"
},
"classOfService": "string",
"comment": "string",
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom21": {
"code": "string",
"href": "string",
"value": "string"
},
"custom22": {
"code": "string",
"href": "string",
"value": "string"
},
"custom23": {
"code": "string",
"href": "string",
"value": "string"
},
"custom24": {
"code": "string",
"href": "string",
"value": "string"
},
"custom25": {
"code": "string",
"href": "string",
"value": "string"
},
"custom26": {
"code": "string",
"href": "string",
"value": "string"
},
"custom27": {
"code": "string",
"href": "string",
"value": "string"
},
"custom28": {
"code": "string",
"href": "string",
"value": "string"
},
"custom29": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom30": {
"code": "string",
"href": "string",
"value": "string"
},
"custom31": {
"code": "string",
"href": "string",
"value": "string"
},
"custom32": {
"code": "string",
"href": "string",
"value": "string"
},
"custom33": {
"code": "string",
"href": "string",
"value": "string"
},
"custom34": {
"code": "string",
"href": "string",
"value": "string"
},
"custom35": {
"code": "string",
"href": "string",
"value": "string"
},
"custom36": {
"code": "string",
"href": "string",
"value": "string"
},
"custom37": {
"code": "string",
"href": "string",
"value": "string"
},
"custom38": {
"code": "string",
"href": "string",
"value": "string"
},
"custom39": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom40": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"endDate": "string",
"endLocation": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"endLocationDetail": "string",
"endTime": "string",
"id": "string",
"returnLeg": false,
"segmentLocator": "string",
"startDate": "string",
"startLocation": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"startLocationDetail": "string",
"startTime": "string",
"vendorName": "string"
}
],
"segmentType": {
"category": "REQ_SEG_AIRFR",
"code": "string"
},
"selfBooked": false,
"tripType": "ONE_WAY"
},
"vendor": {
"id": "string",
"name": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| expenseUuid | path | string | true | The unique identifier of the expected expense to update |
| userId | query | string | false | The unique identifier of the user performing the expected expense update |
| body | body | Expense | true | expense |
Example responses
200 Response
{
"allocations": [
{
"allocationAmount": {
"currency": "string",
"value": 1
},
"allocationId": "string",
"approvedAmount": {
"currency": "string",
"value": 1
},
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"expenseId": "string",
"percentEdited": false,
"percentage": 0,
"postedAmount": {
"currency": "string",
"value": 1
},
"systemAllocation": false
}
],
"approvedAmount": {
"currency": "string",
"value": 1
},
"budgetAccrualDate": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"businessPurpose": "string",
"comments": {
"href": "string",
"id": "string",
"template": "string"
},
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom21": {
"code": "string",
"href": "string",
"value": "string"
},
"custom22": {
"code": "string",
"href": "string",
"value": "string"
},
"custom23": {
"code": "string",
"href": "string",
"value": "string"
},
"custom24": {
"code": "string",
"href": "string",
"value": "string"
},
"custom25": {
"code": "string",
"href": "string",
"value": "string"
},
"custom26": {
"code": "string",
"href": "string",
"value": "string"
},
"custom27": {
"code": "string",
"href": "string",
"value": "string"
},
"custom28": {
"code": "string",
"href": "string",
"value": "string"
},
"custom29": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom30": {
"code": "string",
"href": "string",
"value": "string"
},
"custom31": {
"code": "string",
"href": "string",
"value": "string"
},
"custom32": {
"code": "string",
"href": "string",
"value": "string"
},
"custom33": {
"code": "string",
"href": "string",
"value": "string"
},
"custom34": {
"code": "string",
"href": "string",
"value": "string"
},
"custom35": {
"code": "string",
"href": "string",
"value": "string"
},
"custom36": {
"code": "string",
"href": "string",
"value": "string"
},
"custom37": {
"code": "string",
"href": "string",
"value": "string"
},
"custom38": {
"code": "string",
"href": "string",
"value": "string"
},
"custom39": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom40": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"exchangeRate": {
"operation": "MULTIPLY",
"value": 0
},
"expenseType": {
"href": "string",
"id": "string",
"name": "string"
},
"href": "string",
"id": "string",
"lastComment": "string",
"lastModifiedDate": "string",
"location": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"orgUnit1": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit2": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit3": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit4": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit5": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit6": {
"code": "string",
"href": "string",
"value": "string"
},
"parentRequest": {
"href": "string",
"id": "string",
"template": "string"
},
"postedAmount": {
"currency": "string",
"value": 1
},
"remainingAmount": {
"currency": "string",
"value": 1
},
"source": "CASH_ADVANCE",
"transactionAmount": {
"currency": "string",
"value": 1
},
"transactionDate": "string",
"travelAllowance": {
"dailyTravelAllowanceId": "string"
},
"tripData": {
"agencyBooked": false,
"legs": [
{
"class": {
"code": "string",
"href": "string",
"value": "string"
},
"classOfService": "string",
"comment": "string",
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom21": {
"code": "string",
"href": "string",
"value": "string"
},
"custom22": {
"code": "string",
"href": "string",
"value": "string"
},
"custom23": {
"code": "string",
"href": "string",
"value": "string"
},
"custom24": {
"code": "string",
"href": "string",
"value": "string"
},
"custom25": {
"code": "string",
"href": "string",
"value": "string"
},
"custom26": {
"code": "string",
"href": "string",
"value": "string"
},
"custom27": {
"code": "string",
"href": "string",
"value": "string"
},
"custom28": {
"code": "string",
"href": "string",
"value": "string"
},
"custom29": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom30": {
"code": "string",
"href": "string",
"value": "string"
},
"custom31": {
"code": "string",
"href": "string",
"value": "string"
},
"custom32": {
"code": "string",
"href": "string",
"value": "string"
},
"custom33": {
"code": "string",
"href": "string",
"value": "string"
},
"custom34": {
"code": "string",
"href": "string",
"value": "string"
},
"custom35": {
"code": "string",
"href": "string",
"value": "string"
},
"custom36": {
"code": "string",
"href": "string",
"value": "string"
},
"custom37": {
"code": "string",
"href": "string",
"value": "string"
},
"custom38": {
"code": "string",
"href": "string",
"value": "string"
},
"custom39": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom40": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"endDate": "string",
"endLocation": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"endLocationDetail": "string",
"endTime": "string",
"id": "string",
"returnLeg": false,
"segmentLocator": "string",
"startDate": "string",
"startLocation": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"startLocationDetail": "string",
"startTime": "string",
"vendorName": "string"
}
],
"segmentType": {
"category": "REQ_SEG_AIRFR",
"code": "string"
},
"selfBooked": false,
"tripType": "ONE_WAY"
},
"vendor": {
"id": "string",
"name": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Expense |
| 400 | Bad Request | The request is invalid | ErrorResponse |
| 401 | Unauthorized | Request is not authenticated | None |
| 403 | Forbidden | You do not have permission to perform this operation | None |
| 500 | Internal Server Error | An unexpected error has prevented the operation | ErrorResponse |
| 503 | Service Unavailable | The service is currently unavailable | ErrorResponse |
deleteUsingDELETE
Code samples
# You can also use wget
curl -X DELETE /us.api.concursolutions.com/travelrequest/v4/expenses/{expenseUuid} \
-H 'Accept: */*'
DELETE /us.api.concursolutions.com/travelrequest/v4/expenses/{expenseUuid} HTTP/1.1
Accept: */*
const headers = {
'Accept':'*/*'
};
fetch('/us.api.concursolutions.com/travelrequest/v4/expenses/{expenseUuid}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*'
}
result = RestClient.delete '/us.api.concursolutions.com/travelrequest/v4/expenses/{expenseUuid}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': '*/*'
}
r = requests.delete('/us.api.concursolutions.com/travelrequest/v4/expenses/{expenseUuid}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => '*/*',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/us.api.concursolutions.com/travelrequest/v4/expenses/{expenseUuid}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/us.api.concursolutions.com/travelrequest/v4/expenses/{expenseUuid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/us.api.concursolutions.com/travelrequest/v4/expenses/{expenseUuid}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /expenses/{expenseUuid}
Delete an expected expense from the Request
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| expenseUuid | path | string | true | The unique identifier of the expected expense to delete |
| userId | query | string | false | The unique identifier of the user performing the deletion of the expected expense |
Example responses
200 Response
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | boolean |
| 400 | Bad Request | The request is invalid | ErrorResponse |
| 401 | Unauthorized | Request is not authenticated | None |
| 403 | Forbidden | You do not have permission to perform this operation | None |
| 500 | Internal Server Error | An unexpected error has prevented the operation | ErrorResponse |
| 503 | Service Unavailable | The service is currently unavailable | ErrorResponse |
getCommentsByExpenseUsingGET
Code samples
# You can also use wget
curl -X GET /us.api.concursolutions.com/travelrequest/v4/expenses/{expenseUuid}/comments \
-H 'Accept: application/json'
GET /us.api.concursolutions.com/travelrequest/v4/expenses/{expenseUuid}/comments HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('/us.api.concursolutions.com/travelrequest/v4/expenses/{expenseUuid}/comments',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get '/us.api.concursolutions.com/travelrequest/v4/expenses/{expenseUuid}/comments',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('/us.api.concursolutions.com/travelrequest/v4/expenses/{expenseUuid}/comments', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/us.api.concursolutions.com/travelrequest/v4/expenses/{expenseUuid}/comments', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/us.api.concursolutions.com/travelrequest/v4/expenses/{expenseUuid}/comments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/us.api.concursolutions.com/travelrequest/v4/expenses/{expenseUuid}/comments", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /expenses/{expenseUuid}/comments
Get the list of comments for an existing expected expense
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| expenseUuid | path | string | true | The unique identifier of the expected expense |
| userId | query | string | false | The unique identifier of the user getting the content of the comments |
Example responses
200 Response
[
{
"author": {
"firstName": "string",
"middleInitial": "string",
"href": "string",
"id": "string",
"lastName": "string",
"template": "string"
},
"creationDateTime": "string",
"isLatest": false,
"value": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Inline |
| 400 | Bad Request | The request is invalid | ErrorResponse |
| 401 | Unauthorized | Request is not authenticated | None |
| 403 | Forbidden | You do not have permission to perform this operation | None |
| 500 | Internal Server Error | An unexpected error has prevented the operation | ErrorResponse |
| 503 | Service Unavailable | The service is currently unavailable | ErrorResponse |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [Comment] | false | none | none |
| » author | Employee | false | none | none |
| »» firstName | string | false | none | The first name of the employee |
| »» middleInitial | string | false | none | The middle initial of the employee |
| »» href | string | false | none | Hyperlink to the resource |
| »» id | string | false | none | Unique identifier of the related object |
| »» lastName | string | false | none | The last name of the employee |
| »» template | string | false | none | Hyperlink template to the resource |
| » creationDateTime | string | false | none | Creation date of the comment (in the format YYYY-MM-DD HH:mm:ss.SSS) |
| » isLatest | boolean | false | none | True when the comment has been edited since the last workflow transition |
| » value | string | false | none | Comment value |
Cash Advance Resource
Retrieve cash advance for Concur Request
getUsingGET_1
Code samples
# You can also use wget
curl -X GET /us.api.concursolutions.com/travelrequest/v4/cashadvances/{cashAdvanceUuid} \
-H 'Accept: application/json'
GET /us.api.concursolutions.com/travelrequest/v4/cashadvances/{cashAdvanceUuid} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('/us.api.concursolutions.com/travelrequest/v4/cashadvances/{cashAdvanceUuid}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get '/us.api.concursolutions.com/travelrequest/v4/cashadvances/{cashAdvanceUuid}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('/us.api.concursolutions.com/travelrequest/v4/cashadvances/{cashAdvanceUuid}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/us.api.concursolutions.com/travelrequest/v4/cashadvances/{cashAdvanceUuid}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/us.api.concursolutions.com/travelrequest/v4/cashadvances/{cashAdvanceUuid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/us.api.concursolutions.com/travelrequest/v4/cashadvances/{cashAdvanceUuid}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /cashadvances/{cashAdvanceUuid}
Get the content of an existing cash advance
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| cashAdvanceUuid | path | string | true | The unique identifier of the cash advance |
Example responses
200 Response
{
"amountRequested": {
"currency": "string",
"value": 1
},
"approvalStatus": {
"code": "C_APPR",
"name": "string"
},
"cashAdvanceId": "string",
"comment": "string",
"exchangeRate": {
"operation": "MULTIPLY",
"value": 0
},
"issueDate": "string",
"requestDate": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | CashAdvance |
| 400 | Bad Request | Bad param: invalid Guid | ErrorResponse |
| 401 | Unauthorized | Invalid or nonexistent authorization HTTP header | ErrorResponse |
| 403 | Forbidden | Principal is not allowed to perform operation | None |
| 404 | Not Found | Not found | ErrorResponse |
| 408 | Request Timeout | Time out | ErrorResponse |
| 500 | Internal Server Error | An unexpected error has prevented the operation | ErrorResponse |
| 503 | Service Unavailable | The service is currently unavailable | ErrorResponse |
Schemas
Allocation
{
"allocationAmount": {
"currency": "string",
"value": 1
},
"allocationId": "string",
"approvedAmount": {
"currency": "string",
"value": 1
},
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"expenseId": "string",
"percentEdited": false,
"percentage": 0,
"postedAmount": {
"currency": "string",
"value": 1
},
"systemAllocation": false
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| allocationAmount | Amount | false | none | The amount of the allocation calculated with the percentage value multiplied by the transaction amount on the expense. This amount is given in the transaction's currency |
| allocationId | string | false | none | The unique allocation identifier. |
| approvedAmount | Amount | false | none | The amount of the allocation calculated with the percentage value multiplied by the approved amount on the expense. This amount is given in the user's currency |
| custom1 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom10 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom11 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom12 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom13 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom14 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom15 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom16 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom17 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom18 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom19 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom2 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom20 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom3 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom4 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom5 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom6 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom7 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom8 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom9 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| expenseId | string | false | none | The unique identifier of the expense associated with the allocation |
| percentEdited | boolean | false | none | Whether the allocation percent has been edited |
| percentage | number | false | none | The percentage of the total expense that this allocation represents |
| postedAmount | Amount | false | none | The amount of the allocation calculated with the percentage value multiplied by the posted amount on the expense. This amount is given in the user's currency |
| systemAllocation | boolean | false | none | Whether the allocation is a system allocation. It is usually hidden or read only for Request users |
Amount
{
"currency": "string",
"value": 1
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| currency | string | true | none | The 3-letter ISO 4217 code of the currency in which the amount is expressed |
| value | number | true | none | The amount in the defined currency |
ApprovalStatus
{
"code": "APPROVED",
"name": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| code | string | false | none | The code of the approval status of the Request |
| name | string | false | none | The approval status of the Request in the current user's language |
Enumerated Values
| Property | Value |
|---|---|
| code | APPROVED |
| code | CANCELED |
| code | NOT_SUBMITTED |
| code | PENDING_BOOKING |
| code | SENTBACK |
| code | SUBMITTED |
CashAdvance
{
"amountRequested": {
"currency": "string",
"value": 1
},
"approvalStatus": {
"code": "C_APPR",
"name": "string"
},
"cashAdvanceId": "string",
"comment": "string",
"exchangeRate": {
"operation": "MULTIPLY",
"value": 0
},
"issueDate": "string",
"requestDate": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| amountRequested | Amount | false | none | The amount of the cash advance in the Request, expressed in the reimbursement currency of the employee at the time they created the cash advance |
| approvalStatus | CashAdvanceApprovalStatus | false | none | The approval status of the cash advance |
| cashAdvanceId | string | false | none | The unique identifier of the cash advance |
| comment | string | false | none | The last comment related to this cash advance |
| exchangeRate | ExchangeRate | false | none | The exchange rate that applies to the cash advance |
| issueDate | string | false | none | The date the cash advance was issued |
| requestDate | string | false | none | The date the cash advance was submitted (last submit date in case of recall) |
CashAdvanceApprovalStatus
{
"code": "C_APPR",
"name": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| code | string | false | none | The code of the approval status of the cash advance |
| name | string | false | none | The approval status of the Cash Advance |
Enumerated Values
| Property | Value |
|---|---|
| code | C_APPR |
| code | C_COMP |
| code | C_FILE |
| code | C_ISSU |
| code | C_NISU |
| code | C_NOTF |
| code | C_PECA |
| code | C_PEND |
| code | C_REJE |
Comment
{
"author": {
"firstName": "string",
"middleInitial": "string",
"href": "string",
"id": "string",
"lastName": "string",
"template": "string"
},
"creationDateTime": "string",
"isLatest": false,
"value": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| author | Employee | false | none | Author of the comment |
| creationDateTime | string | false | none | Creation date of the comment (in the format YYYY-MM-DD HH:mm:ss.SSS) |
| isLatest | boolean | false | none | True when the comment has been edited since the last workflow transition |
| value | string | false | none | Comment value |
CustomField
{
"code": "string",
"href": "string",
"value": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| code | string | false | none | The short code of the list item. For non-list fields, this value will be blank |
| href | string | false | none | The link to get this list item on the list service. |
| value | string | false | none | The value of the custom field or the value of the list item id for list fields |
Employee
{
"firstName": "string",
"middleInitial": "string",
"href": "string",
"id": "string",
"lastName": "string",
"template": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| firstName | string | false | none | The first name of the employee |
| middleInitial | string | false | none | The middle initial of the employee |
| href | string | false | none | Hyperlink to the resource |
| id | string | false | none | Unique identifier of the related object |
| lastName | string | false | none | The last name of the employee |
| template | string | false | none | Hyperlink template to the resource |
Expense
{
"allocations": [
{
"allocationAmount": {
"currency": "string",
"value": 1
},
"allocationId": "string",
"approvedAmount": {
"currency": "string",
"value": 1
},
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"expenseId": "string",
"percentEdited": false,
"percentage": 0,
"postedAmount": {
"currency": "string",
"value": 1
},
"systemAllocation": false
}
],
"approvedAmount": {
"currency": "string",
"value": 1
},
"budgetAccrualDate": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"businessPurpose": "string",
"comments": {
"href": "string",
"id": "string",
"template": "string"
},
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom21": {
"code": "string",
"href": "string",
"value": "string"
},
"custom22": {
"code": "string",
"href": "string",
"value": "string"
},
"custom23": {
"code": "string",
"href": "string",
"value": "string"
},
"custom24": {
"code": "string",
"href": "string",
"value": "string"
},
"custom25": {
"code": "string",
"href": "string",
"value": "string"
},
"custom26": {
"code": "string",
"href": "string",
"value": "string"
},
"custom27": {
"code": "string",
"href": "string",
"value": "string"
},
"custom28": {
"code": "string",
"href": "string",
"value": "string"
},
"custom29": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom30": {
"code": "string",
"href": "string",
"value": "string"
},
"custom31": {
"code": "string",
"href": "string",
"value": "string"
},
"custom32": {
"code": "string",
"href": "string",
"value": "string"
},
"custom33": {
"code": "string",
"href": "string",
"value": "string"
},
"custom34": {
"code": "string",
"href": "string",
"value": "string"
},
"custom35": {
"code": "string",
"href": "string",
"value": "string"
},
"custom36": {
"code": "string",
"href": "string",
"value": "string"
},
"custom37": {
"code": "string",
"href": "string",
"value": "string"
},
"custom38": {
"code": "string",
"href": "string",
"value": "string"
},
"custom39": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom40": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"exchangeRate": {
"operation": "MULTIPLY",
"value": 0
},
"expenseType": {
"href": "string",
"id": "string",
"name": "string"
},
"href": "string",
"id": "string",
"lastComment": "string",
"lastModifiedDate": "string",
"location": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"orgUnit1": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit2": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit3": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit4": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit5": {
"code": "string",
"href": "string",
"value": "string"
},
"orgUnit6": {
"code": "string",
"href": "string",
"value": "string"
},
"parentRequest": {
"href": "string",
"id": "string",
"template": "string"
},
"postedAmount": {
"currency": "string",
"value": 1
},
"remainingAmount": {
"currency": "string",
"value": 1
},
"source": "CASH_ADVANCE",
"transactionAmount": {
"currency": "string",
"value": 1
},
"transactionDate": "string",
"travelAllowance": {
"dailyTravelAllowanceId": "string"
},
"tripData": {
"agencyBooked": false,
"legs": [
{
"class": {
"code": "string",
"href": "string",
"value": "string"
},
"classOfService": "string",
"comment": "string",
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom21": {
"code": "string",
"href": "string",
"value": "string"
},
"custom22": {
"code": "string",
"href": "string",
"value": "string"
},
"custom23": {
"code": "string",
"href": "string",
"value": "string"
},
"custom24": {
"code": "string",
"href": "string",
"value": "string"
},
"custom25": {
"code": "string",
"href": "string",
"value": "string"
},
"custom26": {
"code": "string",
"href": "string",
"value": "string"
},
"custom27": {
"code": "string",
"href": "string",
"value": "string"
},
"custom28": {
"code": "string",
"href": "string",
"value": "string"
},
"custom29": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom30": {
"code": "string",
"href": "string",
"value": "string"
},
"custom31": {
"code": "string",
"href": "string",
"value": "string"
},
"custom32": {
"code": "string",
"href": "string",
"value": "string"
},
"custom33": {
"code": "string",
"href": "string",
"value": "string"
},
"custom34": {
"code": "string",
"href": "string",
"value": "string"
},
"custom35": {
"code": "string",
"href": "string",
"value": "string"
},
"custom36": {
"code": "string",
"href": "string",
"value": "string"
},
"custom37": {
"code": "string",
"href": "string",
"value": "string"
},
"custom38": {
"code": "string",
"href": "string",
"value": "string"
},
"custom39": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom40": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"endDate": "string",
"endLocation": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"endLocationDetail": "string",
"endTime": "string",
"id": "string",
"returnLeg": false,
"segmentLocator": "string",
"startDate": "string",
"startLocation": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"startLocationDetail": "string",
"startTime": "string",
"vendorName": "string"
}
],
"segmentType": {
"category": "REQ_SEG_AIRFR",
"code": "string"
},
"selfBooked": false,
"tripType": "ONE_WAY"
},
"vendor": {
"id": "string",
"name": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| allocations | [Allocation] | false | none | List of the allocations composing this segment |
| approvedAmount | Amount | false | none | The approved amount of the expected expense |
| budgetAccrualDate | string | false | none | The date to determine which budgets are affected (in the format yyyy-MM-dd’T’HH:mm:ss.SSS’Z’) |
| businessPurpose | string | false | none | The purpose of the expected expense |
| comments | ResourceLink | false | none | Comment history of the expected expense |
| custom1 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom10 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom11 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom12 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom13 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom14 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom15 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom16 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom17 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom18 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom19 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom2 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom20 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom21 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom22 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom23 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom24 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom25 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom26 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom27 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom28 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom29 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom3 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom30 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom31 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom32 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom33 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom34 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom35 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom36 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom37 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom38 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom39 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom4 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom40 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom5 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom6 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom7 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom8 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom9 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| exchangeRate | ExchangeRate | false | none | The exchange rate that applies to the expected expense |
| expenseType | ExpenseType | false | none | The expense type of the expected expense |
| href | string | false | none | none |
| id | string | false | none | The unique identifier of the expected expense |
| lastComment | string | false | none | The last comment of the expected expense |
| lastModifiedDate | string | false | none | The date when this expense was last modified |
| location | Location | false | none | The location of the expected expense |
| orgUnit1 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| orgUnit2 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| orgUnit3 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| orgUnit4 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| orgUnit5 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| orgUnit6 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| parentRequest | ResourceLink | false | none | The parent Request of the expected expense |
| postedAmount | Amount | false | none | The posted amount of the expected expense |
| remainingAmount | Amount | false | none | The remaining amount of the expected expense |
| source | string | false | none | The source that created the expected expense. It can be CASH_ADVANCE or TRAVEL_ALLOWANCE. This field will be empty in any other case. |
| transactionAmount | Amount | false | none | The amount of the expected expense, in the transaction currency paid to the vendor |
| transactionDate | string | true | none | The date of the transaction |
| travelAllowance | TravelAllowance | false | none | The travel allowance |
| tripData | TripData | false | none | This property is non empty if this expected expense represents a travel Segment (AIR, CAR, HOTEL, ...) |
| vendor | Vendor | false | none | The vendor of the expected expense |
Enumerated Values
| Property | Value |
|---|---|
| source | CASH_ADVANCE |
| source | TRAVEL_ALLOWANCE |
| source | AGENCY_FEE |
ExceptionSource
{
"href": "string",
"id": "string",
"type": "ALLOCATION"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| href | string | false | none | The link to the unique identifier of source. Will be empty if source is ALLOCATION or CASH_ADVANCE. |
| id | string | false | none | The unique identifier of the source |
| type | string | false | none | Defines the type of the source which can be one of "ALLOCATION", "CASH_ADVANCE", "EXPENSE", "HEADER" |
Enumerated Values
| Property | Value |
|---|---|
| type | ALLOCATION |
| type | CASH_ADVANCE |
| type | EXPENSE |
| type | HEADER |
ExchangeRate
{
"operation": "MULTIPLY",
"value": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| operation | string | true | none | Exchange rate operation. Possible values: 'MULTIPLY' or 'DIVIDE' |
| value | number | true | none | Exchange rate value |
Enumerated Values
| Property | Value |
|---|---|
| operation | MULTIPLY |
| operation | DIVIDE |
ExpenseType
{
"href": "string",
"id": "string",
"name": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| href | string | false | none | Hyperlink to the resource for the expense type definition |
| id | string | true | none | Unique identifier of the expense type |
| name | string | false | none | Name of the expense type |
ErrorResponse
{
"errors": [
{}
],
"exception": "string",
"message": "string",
"path": "string",
"timestamp": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| errors | [object] | false | none | none |
| exception | string | false | none | none |
| message | string | false | none | none |
| path | string | false | none | none |
| timestamp | integer(int64) | false | none | none |
Link
{
"href": "string",
"rel": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| href | string | false | none | Hyperlink to the resource. |
| rel | string | false | none | Relation type as defined by the server. |
ListItemField
{
"code": "string",
"href": "string",
"value": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| code | string | false | none | The short code of the list item. |
| href | string | false | none | Hyperlink to the resource for the list item. |
| value | string | false | none | The value of the list item id. |
Location
{
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| city | string | false | none | The city name of the location |
| countryCode | string | false | none | The ISO 3166-1 country code |
| countrySubDivisionCode | string | false | none | The ISO 3166-2 country sub code |
| iataCode | string | false | none | The IATA code for the location |
| id | string | false | none | The id of the location |
| latitude | number | false | none | The latitude of the location |
| locationCode | string | false | none | The code of the location |
| locationType | string | false | none | The type of the location |
| longitude | number | false | none | The longitude of the location |
| name | string | false | none | The name of the location |
PageResultOfResourceOfRequest
{
"data": [
{
"approvalLimitDate": "string",
"approvalStatus": {
"code": "APPROVED",
"name": "string"
},
"approved": true,
"approver": {
"firstName": "string",
"middleInitial": "string",
"href": "string",
"id": "string",
"lastName": "string",
"template": "string"
},
"authorizedDate": "string",
"businessPurpose": "string",
"canceledPostApproval": true,
"closed": false,
"comment": "string",
"comments": {
"href": "string",
"id": "string",
"template": "string"
},
"creationDate": "string",
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"endDate": "string",
"endTime": "string",
"everSentBack": false,
"expenses": [
{
"href": "string",
"id": "string",
"template": "string"
}
],
"extensionOf": {
"requestId": "string"
},
"highestExceptionLevel": "NONE",
"href": "string",
"id": "string",
"lastModified": "string",
"mainDestination": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"name": "string",
"operations": [
{
"href": "string",
"rel": "string"
}
],
"owner": {
"firstName": "string",
"middleInitial": "string",
"href": "string",
"id": "string",
"lastName": "string",
"template": "string"
},
"pendingApproval": true,
"policy": {
"href": "string",
"id": "string",
"template": "string"
},
"requestId": "string",
"startDate": "string",
"startTime": "string",
"submitDate": "string",
"totalApprovedAmount": {
"currency": "string",
"value": 1
},
"totalPostedAmount": {
"currency": "string",
"value": 1
},
"totalRemainingAmount": {
"currency": "string",
"value": 1
},
"travelAgency": {
"href": "string",
"id": "string",
"template": "string"
},
"type": {
"code": "string",
"label": "string"
}
}
],
"operations": [
{
"href": "string",
"rel": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| data | [Request] | false | none | none |
| operations | [Link] | false | none | none |
Request
{
"approvalLimitDate": "string",
"approvalStatus": {
"code": "APPROVED",
"name": "string"
},
"approved": true,
"approver": {
"firstName": "string",
"middleInitial": "string",
"href": "string",
"id": "string",
"lastName": "string",
"template": "string"
},
"authorizedDate": "string",
"businessPurpose": "string",
"canceledPostApproval": true,
"closed": false,
"comment": "string",
"comments": {
"href": "string",
"id": "string",
"template": "string"
},
"creationDate": "string",
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"endDate": "string",
"endTime": "string",
"everSentBack": false,
"expenses": [
{
"href": "string",
"id": "string",
"template": "string"
}
],
"extensionOf": {
"requestId": "string"
},
"highestExceptionLevel": "NONE",
"href": "string",
"id": "string",
"lastModified": "string",
"mainDestination": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"name": "string",
"operations": [
{
"href": "string",
"rel": "string"
}
],
"owner": {
"firstName": "string",
"middleInitial": "string",
"href": "string",
"id": "string",
"lastName": "string",
"template": "string"
},
"pendingApproval": true,
"policy": {
"href": "string",
"id": "string",
"template": "string"
},
"requestId": "string",
"startDate": "string",
"startTime": "string",
"submitDate": "string",
"totalApprovedAmount": {
"currency": "string",
"value": 1
},
"totalPostedAmount": {
"currency": "string",
"value": 1
},
"totalRemainingAmount": {
"currency": "string",
"value": 1
},
"travelAgency": {
"href": "string",
"id": "string",
"template": "string"
},
"type": {
"code": "string",
"label": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| approvalLimitDate | string | false | none | The date by which the Request must be approved. This element appears only when integrated with Concur Travel |
| approvalStatus | ApprovalStatus | false | none | The approval status of the Request |
| approved | boolean | false | none | Indicates whether this Request is approved |
| approver | Employee | false | none | The approver of this Request. Null when Request is in an approval status different from SUBMITTED |
| authorizedDate | string | false | none | For an approved Request, the date the approval process was completed |
| businessPurpose | string | false | none | The business purpose of the Request |
| canceledPostApproval | boolean | false | none | Indicates whether this Request was canceled post approval |
| closed | boolean | false | none | Indicates whether the Request is closed |
| comment | string | false | none | The last comment attached to this Request |
| comments | ResourceLink | false | none | Comment history of this Request |
| creationDate | string | false | none | The date when the Request was created (in the format yyyy-MM-dd'T'HH:mm:ss.SSS'Z') |
| custom1 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom10 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom11 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom12 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom13 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom14 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom15 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom16 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom17 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom18 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom19 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom2 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom20 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom3 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom4 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom5 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom6 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom7 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom8 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom9 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| endDate | string | false | none | The end date of the Request (in the format YYYY-MM-DD) |
| endTime | string | false | none | The end time of the Request (in the format HH:MM) |
| everSentBack | boolean | false | none | Indicates whether the Request has ever been sent back to the employee |
| expenses | [ResourceLink] | false | none | Expected expenses attached to this Request |
| extensionOf | RequestLink | false | none | The Request that this Request is an extension of, or addendum to |
| highestExceptionLevel | string | false | none | The highest level of exception contained in this Request. One of { NONE, WARNING, ERROR } |
| href | string | false | none | Hyperlink to the resource for this Request |
| id | string | false | none | The unique identifier of the Request |
| lastModified | string | false | none | The date when the Request was last modified |
| mainDestination | Location | false | none | The main destination of the Request |
| name | string | false | none | The name of the Request |
| operations | [Link] | false | none | none |
| owner | Employee | false | none | The employee who owns the Request |
| pendingApproval | boolean | false | none | Indicates whether this Request is pending approval |
| policy | ResourceLink | false | none | The policy that applies to the Request |
| requestId | string | false | none | The public key of the Request (unique per customer) |
| startDate | string | false | none | The start date of the Request (in the format YYYY-MM-DD) |
| startTime | string | false | none | The start time of the Request (in the format HH:MM) |
| submitDate | string | false | none | The date when the Request was submitted (last submit date in case of recall) |
| totalApprovedAmount | Amount | false | none | The total amount of approved expenses in the Request, expressed in the reimbursement currency of the employee at the time they created the Request |
| totalPostedAmount | Amount | false | none | The total amount of the Request, expressed in the reimbursement currency of the employee at the time he created the Request |
| totalRemainingAmount | Amount | false | none | The total amount not included in an Expense report, expressed in the reimbursement currency of the employee at the time he created the Request |
| travelAgency | ResourceLink | false | none | The travel agency office that is managing the trip associated to this Request |
| type | RequestType | false | none | The type of the Request, inherited from the Request policy type |
Enumerated Values
| Property | Value |
|---|---|
| highestExceptionLevel | NONE |
| highestExceptionLevel | WARNING |
| highestExceptionLevel | ERROR |
RequestDetails
{
"approvalLimitDate": "string",
"approvalStatus": {
"code": "APPROVED",
"name": "string"
},
"approved": true,
"approver": {
"firstName": "string",
"middleInitial": "string",
"href": "string",
"id": "string",
"lastName": "string",
"template": "string"
},
"authorizedDate": "string",
"businessPurpose": "string",
"canceledPostApproval": true,
"cashAdvances": {
"href": "string",
"id": "string",
"template": "string"
},
"closed": false,
"comment": "string",
"comments": {
"href": "string",
"id": "string",
"template": "string"
},
"creationDate": "string",
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"endDate": "string",
"endTime": "string",
"everSentBack": false,
"exceptions": {
"href": "string",
"id": "string",
"template": "string"
},
"expenses": [
{
"href": "string",
"id": "string",
"template": "string"
}
],
"extensionOf": {
"requestId": "string"
},
"highestExceptionLevel": "NONE",
"href": "string",
"id": "string",
"lastModified": "string",
"mainDestination": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"name": "string",
"operations": [
{
"href": "string",
"rel": "string"
}
],
"owner": {
"firstName": "string",
"middleInitial": "string",
"href": "string",
"id": "string",
"lastName": "string",
"template": "string"
},
"pendingApproval": true,
"policy": {
"href": "string",
"id": "string",
"template": "string"
},
"requestId": "string",
"startDate": "string",
"startTime": "string",
"submitDate": "string",
"totalApprovedAmount": {
"currency": "string",
"value": 1
},
"totalPostedAmount": {
"currency": "string",
"value": 1
},
"totalRemainingAmount": {
"currency": "string",
"value": 1
},
"travelAgency": {
"href": "string",
"id": "string",
"template": "string"
},
"type": {
"code": "string",
"label": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| approvalLimitDate | string | false | none | The date by which the Request must be approved. This element appears only when integrated with Concur Travel |
| approvalStatus | ApprovalStatus | false | none | The approval status of the Request |
| approved | boolean | false | none | Indicates whether this Request is approved |
| approver | Employee | false | none | The approver of this Request. Null when Request is in an approval status different from SUBMITTED |
| authorizedDate | string | false | none | For an approved Request, the date the approval process was completed |
| businessPurpose | string | false | none | The business purpose of the Request |
| canceledPostApproval | boolean | false | none | Indicates whether this Request was canceled post approval |
| cashAdvances | ResourceLink | false | none | The cash advances attached to this Request |
| closed | boolean | false | none | Indicates whether the Request is closed |
| comment | string | false | none | The last comment attached to this Request |
| comments | ResourceLink | false | none | Comment history of this Request |
| creationDate | string | false | none | The date when the Request was created (in the format yyyy-MM-dd'T'HH:mm:ss.SSS'Z') |
| custom1 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom10 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom11 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom12 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom13 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom14 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom15 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom16 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom17 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom18 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom19 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom2 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom20 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom3 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom4 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom5 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom6 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom7 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom8 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom9 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| endDate | string | false | none | The end date of the Request (in the format YYYY-MM-DD) |
| endTime | string | false | none | The end time of the Request (in the format HH:MM) |
| everSentBack | boolean | false | none | Indicates whether the Request has ever been sent back to the employee |
| exceptions | ResourceLink | false | none | List of exceptions of this Request |
| expenses | [ResourceLink] | false | none | Expected expenses attached to this Request |
| extensionOf | RequestLink | false | none | The Request that this Request is an extension of, or addendum to |
| highestExceptionLevel | string | false | none | The highest level of exception contained in this Request. One of { NONE, WARNING, ERROR } |
| href | string | false | none | Hyperlink to the resource for this Request |
| id | string | false | none | The unique identifier of the Request |
| lastModified | string | false | none | The date when the Request was last modified |
| mainDestination | Location | false | none | The main destination of the Request |
| name | string | false | none | The name of the Request |
| operations | [Link] | false | none | none |
| owner | Employee | false | none | The employee who owns the Request |
| pendingApproval | boolean | false | none | Indicates whether this Request is pending approval |
| policy | ResourceLink | false | none | The policy that applies to the Request |
| requestId | string | false | none | The public key of the Request (unique per customer) |
| startDate | string | false | none | The start date of the Request (in the format YYYY-MM-DD) |
| startTime | string | false | none | The start time of the Request (in the format HH:MM) |
| submitDate | string | false | none | The date when the Request was submitted (last submit date in case of recall) |
| totalApprovedAmount | Amount | false | none | The total amount of approved expenses in the Request, expressed in the reimbursement currency of the employee at the time they created the Request |
| totalPostedAmount | Amount | false | none | The total amount of the Request, expressed in the reimbursement currency of the employee at the time he created the Request |
| totalRemainingAmount | Amount | false | none | The total amount not included in an Expense report, expressed in the reimbursement currency of the employee at the time he created the Request |
| travelAgency | ResourceLink | false | none | The travel agency office that is managing the trip associated to this Request |
| type | RequestType | false | none | The type of the Request, inherited from the Request policy type |
Enumerated Values
| Property | Value |
|---|---|
| highestExceptionLevel | NONE |
| highestExceptionLevel | WARNING |
| highestExceptionLevel | ERROR |
RequestException
{
"code": "string",
"isBlocking": false,
"level": 0,
"message": "string",
"parameters": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"source": {
"href": "string",
"id": "string",
"type": "ALLOCATION"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| code | string | false | none | The system exception code defined for the exception. Example: BADCODE |
| isBlocking | boolean | false | none | Defines whether the exception will prevent the Request from being submitted |
| level | integer(int64) | false | none | The numeric level associated with the exception. Example: 99 |
| message | string | false | none | The user-facing message defined for the exception |
| parameters | object | false | none | Parameters for the messages of the exception |
| » additionalProperties | [string] | false | none | none |
| source | ExceptionSource | false | none | The source of the exception |
RequestLink
{
"requestId": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| requestId | string | false | none | The public id of the Request |
ResourceLink
{
"href": "string",
"id": "string",
"template": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| href | string | false | none | Hyperlink to the resource |
| id | string | false | none | Unique identifier of the related object |
| template | string | false | none | Hyperlink template to the resource |
RequestType
{
"code": "string",
"label": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| code | string | false | none | The code of the type inherited from the Request policy type |
| label | string | false | none | The label of the type inherited from the Request policy type |
ResourceOfPolicy
{
"href": "string",
"id": "string",
"name": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| href | string | false | none | Hyperlink to the resource for this Request policy |
| id | string | false | none | Unique identifier of the Request policy |
| name | string | false | none | Name of the Request policy |
ResourceOfTravelAgency
{
"emailAddress": "string",
"id": "string",
"name": "string",
"proposalType": "CWTF"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| emailAddress | string | false | none | The travel agency email address |
| id | string | false | none | The travel agency unique identifier |
| name | string | false | none | The travel agency office name |
| proposalType | string | false | none | The travel agency proposal type |
Enumerated Values
| Property | Value |
|---|---|
| proposalType | CWTF |
| proposalType | AEBT |
| proposalType | API |
| proposalType | NONE |
SegmentLeg
{
"class": {
"code": "string",
"href": "string",
"value": "string"
},
"classOfService": "string",
"comment": "string",
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom21": {
"code": "string",
"href": "string",
"value": "string"
},
"custom22": {
"code": "string",
"href": "string",
"value": "string"
},
"custom23": {
"code": "string",
"href": "string",
"value": "string"
},
"custom24": {
"code": "string",
"href": "string",
"value": "string"
},
"custom25": {
"code": "string",
"href": "string",
"value": "string"
},
"custom26": {
"code": "string",
"href": "string",
"value": "string"
},
"custom27": {
"code": "string",
"href": "string",
"value": "string"
},
"custom28": {
"code": "string",
"href": "string",
"value": "string"
},
"custom29": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom30": {
"code": "string",
"href": "string",
"value": "string"
},
"custom31": {
"code": "string",
"href": "string",
"value": "string"
},
"custom32": {
"code": "string",
"href": "string",
"value": "string"
},
"custom33": {
"code": "string",
"href": "string",
"value": "string"
},
"custom34": {
"code": "string",
"href": "string",
"value": "string"
},
"custom35": {
"code": "string",
"href": "string",
"value": "string"
},
"custom36": {
"code": "string",
"href": "string",
"value": "string"
},
"custom37": {
"code": "string",
"href": "string",
"value": "string"
},
"custom38": {
"code": "string",
"href": "string",
"value": "string"
},
"custom39": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom40": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"endDate": "string",
"endLocation": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"endLocationDetail": "string",
"endTime": "string",
"id": "string",
"returnLeg": false,
"segmentLocator": "string",
"startDate": "string",
"startLocation": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"startLocationDetail": "string",
"startTime": "string",
"vendorName": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| class | ListItemField | false | none | The class of the segment leg. |
| classOfService | string | false | none | The class of service of the segment leg. For example, in the case of an air segment, this field would contain the one-letter booking code: Y for economy class, or F for first class... |
| comment | string | false | none | A comment for this segment leg |
| custom1 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom10 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom11 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom12 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom13 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom14 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom15 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom16 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom17 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom18 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom19 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom2 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom20 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom21 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom22 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom23 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom24 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom25 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom26 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom27 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom28 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom29 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom3 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom30 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom31 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom32 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom33 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom34 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom35 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom36 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom37 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom38 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom39 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom4 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom40 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom5 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom6 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom7 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom8 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| custom9 | CustomField | false | none | The details from the Custom fields. These fields may not have data, depending on the configuration |
| endDate | string | false | none | The end date of the segment leg (in the format YYYY-MM-DD).It represents the arrival date of AIRFR and TRAIN segments, check out date for HOTEL or drop off for CARRT |
| endLocation | Location | false | none | The end location of the segment leg |
| endLocationDetail | string | false | none | Additional details about the end location. It is used for HOTEL and CARRT segments. |
| endTime | string | false | none | The end time of the segment leg (in the format HH:MM). It is expressed in the local time of the end location |
| id | string | false | none | The unique identifier of the segment leg |
| returnLeg | boolean | false | none | This value indicates if the leg is a return leg or not. |
| segmentLocator | string | false | none | The identifier for Concur Travel segments |
| startDate | string | false | none | The start date of the segment leg (in the format YYYY-MM-DD). It represents the departure date of AIRFR and TRAIN segments, check in date for HOTEL or pickup for CARRT |
| startLocation | Location | false | none | The start location of the segment leg (for HOTEL, this is empty) |
| startLocationDetail | string | false | none | Additional details about the start location. It is used for HOTEL and CARRT segments. |
| startTime | string | false | none | The start time of the segment leg (in the format HH:MM). It is expressed in the local time of the start location |
| vendorName | string | false | none | The name of the vendor of this segment leg. |
SegmentType
{
"category": "REQ_SEG_AIRFR",
"code": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| category | string | false | none | The category of the segment type |
| code | string | false | none | The code of the segment type. This will most frequently be a String, but could also be an integer in the case of a custom expense typeFor example, would be category = REQ_SEG_AIRFR and code = AIRFR for a regular air segment, but category = REQ_SEG_AIRFR and code = 10325 for a custom air segment. |
Enumerated Values
| Property | Value |
|---|---|
| category | REQ_SEG_AIRFR |
| category | REQ_SEG_CARRT |
| category | REQ_SEG_HOTEL |
| category | REQ_SEG_LIMOF |
| category | REQ_SEG_RAILF |
| category | REQ_SEG_TAXIF |
| category | REQ_SEG_MISC |
| category | REQ_SEG_PARKG |
| category | REQ_SEG_DININ |
| category | REQ_SEG_EVENT |
TravelAllowance
{
"dailyTravelAllowanceId": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| dailyTravelAllowanceId | string | false | none | The fixed daily travel allowance id associated with the expected expense |
TripData
{
"agencyBooked": false,
"legs": [
{
"class": {
"code": "string",
"href": "string",
"value": "string"
},
"classOfService": "string",
"comment": "string",
"custom1": {
"code": "string",
"href": "string",
"value": "string"
},
"custom10": {
"code": "string",
"href": "string",
"value": "string"
},
"custom11": {
"code": "string",
"href": "string",
"value": "string"
},
"custom12": {
"code": "string",
"href": "string",
"value": "string"
},
"custom13": {
"code": "string",
"href": "string",
"value": "string"
},
"custom14": {
"code": "string",
"href": "string",
"value": "string"
},
"custom15": {
"code": "string",
"href": "string",
"value": "string"
},
"custom16": {
"code": "string",
"href": "string",
"value": "string"
},
"custom17": {
"code": "string",
"href": "string",
"value": "string"
},
"custom18": {
"code": "string",
"href": "string",
"value": "string"
},
"custom19": {
"code": "string",
"href": "string",
"value": "string"
},
"custom2": {
"code": "string",
"href": "string",
"value": "string"
},
"custom20": {
"code": "string",
"href": "string",
"value": "string"
},
"custom21": {
"code": "string",
"href": "string",
"value": "string"
},
"custom22": {
"code": "string",
"href": "string",
"value": "string"
},
"custom23": {
"code": "string",
"href": "string",
"value": "string"
},
"custom24": {
"code": "string",
"href": "string",
"value": "string"
},
"custom25": {
"code": "string",
"href": "string",
"value": "string"
},
"custom26": {
"code": "string",
"href": "string",
"value": "string"
},
"custom27": {
"code": "string",
"href": "string",
"value": "string"
},
"custom28": {
"code": "string",
"href": "string",
"value": "string"
},
"custom29": {
"code": "string",
"href": "string",
"value": "string"
},
"custom3": {
"code": "string",
"href": "string",
"value": "string"
},
"custom30": {
"code": "string",
"href": "string",
"value": "string"
},
"custom31": {
"code": "string",
"href": "string",
"value": "string"
},
"custom32": {
"code": "string",
"href": "string",
"value": "string"
},
"custom33": {
"code": "string",
"href": "string",
"value": "string"
},
"custom34": {
"code": "string",
"href": "string",
"value": "string"
},
"custom35": {
"code": "string",
"href": "string",
"value": "string"
},
"custom36": {
"code": "string",
"href": "string",
"value": "string"
},
"custom37": {
"code": "string",
"href": "string",
"value": "string"
},
"custom38": {
"code": "string",
"href": "string",
"value": "string"
},
"custom39": {
"code": "string",
"href": "string",
"value": "string"
},
"custom4": {
"code": "string",
"href": "string",
"value": "string"
},
"custom40": {
"code": "string",
"href": "string",
"value": "string"
},
"custom5": {
"code": "string",
"href": "string",
"value": "string"
},
"custom6": {
"code": "string",
"href": "string",
"value": "string"
},
"custom7": {
"code": "string",
"href": "string",
"value": "string"
},
"custom8": {
"code": "string",
"href": "string",
"value": "string"
},
"custom9": {
"code": "string",
"href": "string",
"value": "string"
},
"endDate": "string",
"endLocation": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"endLocationDetail": "string",
"endTime": "string",
"id": "string",
"returnLeg": false,
"segmentLocator": "string",
"startDate": "string",
"startLocation": {
"city": "string",
"countryCode": "string",
"countrySubDivisionCode": "string",
"iataCode": "string",
"id": "string",
"latitude": 0,
"locationCode": "string",
"locationType": "string",
"longitude": 0,
"name": "string"
},
"startLocationDetail": "string",
"startTime": "string",
"vendorName": "string"
}
],
"segmentType": {
"category": "REQ_SEG_AIRFR",
"code": "string"
},
"selfBooked": false,
"tripType": "ONE_WAY"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| agencyBooked | boolean | false | none | Indicates whether this trip has been booked by a Travel Agency or not. True if this trip is (or has to be) handled by a Travel Agency. |
| legs | [SegmentLeg] | false | none | List of the legs composing this segment |
| segmentType | SegmentType | true | none | The type of the segment |
| selfBooked | boolean | false | none | True if this trip has been reserved by Concur Travel, or if Concur Travel has retrieved the trip information in the GDS |
| tripType | string | false | none | Indicates the type of this trip. Possible values are: ONE_WAY, ROUND_TRIP, MULTI_STOPS |
Enumerated Values
| Property | Value |
|---|---|
| tripType | ONE_WAY |
| tripType | ROUND_TRIP |
| tripType | MULTI_STOPS |
Vendor
{
"id": "string",
"name": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | false | none | The vendor identifier of the expected expense |
| name | string | false | none | The vendor description of the expected expense |
WorkflowAction
"string"
Comment when the workflow action is ‘sendback’.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | Comment when the workflow action is ‘sendback’. |